curl --request POST \
--url https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Brand-Id: <x-brand-id>' \
--data '
{
"offering_ref": "<string>"
}
'import requests
url = "https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings"
payload = { "offering_ref": "<string>" }
headers = {
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Brand-Id': '<x-brand-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({offering_ref: '<string>'})
};
fetch('https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings', 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.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'offering_ref' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings"
payload := strings.NewReader("{\n \"offering_ref\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Brand-Id", "<x-brand-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offering_ref\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offering_ref\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"brand_id": "<string>",
"checks": [
{
"check": "<string>",
"detail": "<string>",
"kind": "performed",
"blocking": true,
"result": "pass"
}
],
"client_id": "<string>",
"enabled_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"offering_ref": "<string>",
"sku_id": "<string>",
"status": "enabled_pending_activation"
}
}{
"data": {
"brand_id": "<string>",
"checks": [
{
"check": "<string>",
"detail": "<string>",
"kind": "performed",
"blocking": true,
"result": "pass"
}
],
"client_id": "<string>",
"enabled_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"offering_ref": "<string>",
"sku_id": "<string>",
"status": "enabled_pending_activation"
}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}Enable an offering for your brand
Enables an offering for YOUR brand using your own API key — records the intent “enable offering Y for my brand” and answers with the enablement and its computed activation report. The brand is the one your key owns (resolved from X-Brand-Id); the brand_id in the path must match it (any mismatch, foreign, or unknown brand answers 404, never 403 — no cross-tenant existence leak). The offering_ref must already exist in the canonical catalog: an unknown offering is 404, never auto-created (nothing invented, nothing derived from the SKU code). Idempotency-Key is carried through — replay of the same request returns the original result. This is enablement configuration, NOT a price path (no money moves; pricing self-serve is a separate surface).
curl --request POST \
--url https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Brand-Id: <x-brand-id>' \
--data '
{
"offering_ref": "<string>"
}
'import requests
url = "https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings"
payload = { "offering_ref": "<string>" }
headers = {
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Brand-Id': '<x-brand-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({offering_ref: '<string>'})
};
fetch('https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings', 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.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'offering_ref' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings"
payload := strings.NewReader("{\n \"offering_ref\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Brand-Id", "<x-brand-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offering_ref\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.purplelabelmd.com/v1/account/brands/{brand_id}/offerings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offering_ref\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"brand_id": "<string>",
"checks": [
{
"check": "<string>",
"detail": "<string>",
"kind": "performed",
"blocking": true,
"result": "pass"
}
],
"client_id": "<string>",
"enabled_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"offering_ref": "<string>",
"sku_id": "<string>",
"status": "enabled_pending_activation"
}
}{
"data": {
"brand_id": "<string>",
"checks": [
{
"check": "<string>",
"detail": "<string>",
"kind": "performed",
"blocking": true,
"result": "pass"
}
],
"client_id": "<string>",
"enabled_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"offering_ref": "<string>",
"sku_id": "<string>",
"status": "enabled_pending_activation"
}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>"
}Authorizations
Per-client API key (M2M). Presented as Authorization: Bearer <key>.
Headers
Opaque brand id (brd_...). Validated to belong to the resolved client (§2).
^brd_[A-Za-z0-9][A-Za-z0-9_-]*$Accepted on mutations; carried in trusted context, enforced in a later WI.
Path Parameters
the brand to enable the offering for (must match X-Brand-Id).
^brd_[A-Za-z0-9][A-Za-z0-9_-]*$Body
The enable request body — the offering to enable for your brand. The brand is resolved from your key (the path brand_id must match X-Brand-Id) and is never carried here.
the offering code to enable (offering_ref = the catalog offering/SKU code); must exist in the canonical catalog.
1Response
the offering was already enabled — an idempotent re-enable or replay
An enablement record with its computed activation status. The status is derived from the activation checks on every response — never stored and never writable; "active" cannot appear while any performed check fails, a check is unverifiable, or a check was not performed.
Show child attributes
Show child attributes