Remove an offering's qualification question
curl --request DELETE \
--url https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id} \
--header 'Authorization: Bearer <token>' \
--header 'X-Brand-Id: <x-brand-id>'import requests
url = "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}"
headers = {
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Brand-Id': '<x-brand-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Brand-Id: <x-brand-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Brand-Id", "<x-brand-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"where": "<string>",
"already_asked": {
"asked_as": "dob",
"asked_by": "q_dob",
"prompt": "What is your date of birth?",
"section_id": "about_you",
"section_title": "About you"
},
"missing_values": [
"US-AL",
"US-AK"
],
"readers": [
{
"id": "<string>",
"kind": "rule"
}
],
"refresh_policy": "static",
"value_type": "string"
}
],
"landed_first": {
"actor": "<string>",
"at": "2023-11-07T05:31:56Z",
"bundle_hash": "<string>",
"source": "activation_history",
"action": "set_create",
"question_id": "<string>",
"section_id": "<string>"
},
"mdi_case_id": "<string>",
"prescriber_case_id": "<string>",
"required_role": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"where": "<string>",
"already_asked": {
"asked_as": "dob",
"asked_by": "q_dob",
"prompt": "What is your date of birth?",
"section_id": "about_you",
"section_title": "About you"
},
"missing_values": [
"US-AL",
"US-AK"
],
"readers": [
{
"id": "<string>",
"kind": "rule"
}
],
"refresh_policy": "static",
"value_type": "string"
}
],
"landed_first": {
"actor": "<string>",
"at": "2023-11-07T05:31:56Z",
"bundle_hash": "<string>",
"source": "activation_history",
"action": "set_create",
"question_id": "<string>",
"section_id": "<string>"
},
"mdi_case_id": "<string>",
"prescriber_case_id": "<string>",
"required_role": "<string>",
"type": "<string>"
}Offering configuration
Remove an offering's qualification question
Removes the offering’s copy of a question. The library original is unaffected.
DELETE
/
v1
/
account
/
offerings
/
{offering_ref}
/
qualification
/
questions
/
{question_id}
Remove an offering's qualification question
curl --request DELETE \
--url https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id} \
--header 'Authorization: Bearer <token>' \
--header 'X-Brand-Id: <x-brand-id>'import requests
url = "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}"
headers = {
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Brand-Id': '<x-brand-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Brand-Id: <x-brand-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Brand-Id", "<x-brand-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.purplelabelmd.com/v1/account/offerings/{offering_ref}/qualification/questions/{question_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"where": "<string>",
"already_asked": {
"asked_as": "dob",
"asked_by": "q_dob",
"prompt": "What is your date of birth?",
"section_id": "about_you",
"section_title": "About you"
},
"missing_values": [
"US-AL",
"US-AK"
],
"readers": [
{
"id": "<string>",
"kind": "rule"
}
],
"refresh_policy": "static",
"value_type": "string"
}
],
"landed_first": {
"actor": "<string>",
"at": "2023-11-07T05:31:56Z",
"bundle_hash": "<string>",
"source": "activation_history",
"action": "set_create",
"question_id": "<string>",
"section_id": "<string>"
},
"mdi_case_id": "<string>",
"prescriber_case_id": "<string>",
"required_role": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"where": "<string>",
"already_asked": {
"asked_as": "dob",
"asked_by": "q_dob",
"prompt": "What is your date of birth?",
"section_id": "about_you",
"section_title": "About you"
},
"missing_values": [
"US-AL",
"US-AK"
],
"readers": [
{
"id": "<string>",
"kind": "rule"
}
],
"refresh_policy": "static",
"value_type": "string"
}
],
"landed_first": {
"actor": "<string>",
"at": "2023-11-07T05:31:56Z",
"bundle_hash": "<string>",
"source": "activation_history",
"action": "set_create",
"question_id": "<string>",
"section_id": "<string>"
},
"mdi_case_id": "<string>",
"prescriber_case_id": "<string>",
"required_role": "<string>",
"type": "<string>"
}Authorizations
Per-client API key (M2M). Presented as Authorization: Bearer <key>.
Headers
Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.
Pattern:
^brd_[A-Za-z0-9][A-Za-z0-9_-]*$Response
removed — no response body. The library original is unaffected.