Ozibus Developer PlatformDeveloper Platform API reference

API base https://api.ozibus.com.au/v1 Billing Prepaid PAYG via Ozibus Account Balance API & Developer Terms

API reference

Marketing Email: Unsubscribe

Record a durable opt-out for a subscriber within one merchant domain.

Ozibus Developer Platform

POST

Endpoint /v1/unsubscribe https://api.ozibus.com.au/v1/unsubscribe

Unsubscribe a contact

Marks the matching merchant/domain contact as opted out so future campaigns can honour the suppression decision.

JSON body

{"id":"CONTACT_REFERENCE_FROM_GET_SUBSCRIBERS","source_domain_id":"587980a6-d5f1-45fe-a9cf-4c3ededd02f1"}

Both fields are required. A contact reference from another merchant or domain is rejected.

GET

/v1/unsubscribe

Request to /v1/unsubscribe

Headers

Name	Description	Required
API-Key	YOUR_API_KEY	Yes
Merchant-Id	YOUR_MERCHANT_ID	Yes
Content-Type	application/json	Yes

Request Body

Parameter	Type	Description	Required
id	string		Yes
source_domain_id	string		Yes

Was this page useful?Your response helps us improve the developer journey.

Report a docs issue

On this page

Example requestPlaceholders only — never paste live secrets into docs

Detected: curl

curl -X POST https://api.ozibus.com.au/v1/unsubscribe -H "Content-Type: application/json" -H "Merchant-Id: YOUR_MERCHANT_ID" -H "Api-Key: " -d '{"id":"CONTACT_REFERENCE_FROM_GET_SUBSCRIBERS","source_domain_id":"587980a6-d5f1-45fe-a9cf-4c3ededd02f1"}'

$payload = ["id" => "CONTACT_REFERENCE_FROM_GET_SUBSCRIBERS", "source_domain_id" => "587980a6-d5f1-45fe-a9cf-4c3ededd02f1"];

$client->post("https://api.ozibus.com.au/v1/unsubscribe", ["headers" => ["Merchant-Id" => $merchantId, "Api-Key" => $secretKey], "json" => $payload]);

Detected: javascript

await fetch("https://api.ozibus.com.au/v1/unsubscribe", {method:"POST", headers:{"Content-Type":"application/json","Merchant-Id":process.env.OZIBUS_MERCHANT_ID,"Api-Key":process.env.OZIBUS_SECRET_KEY}, body:JSON.stringify(payload)});

Detected: python

requests.post("https://api.ozibus.com.au/v1/unsubscribe", headers={"Merchant-Id": merchant_id, "Api-Key": secret_key}, json=payload)

{"response_code":0,"response_message":"You have been unsubscribed successfully.","data":[]}

{"response_code":20,"response_message":"Contact not found.","data":[]}

Examples show the request shape represented by the current documentation data. Validate production behaviour and response schemas before relying on an example for a critical workflow.

Having trouble?Talk to developer support

Unsubscribe a contact

JSON body

Headers

Request Body

Related in Messaging APIs