Marketing Email: Subscribe
Add a consented subscriber to the audience for one verified merchant domain.
Endpoint
/v1/newsletter
https://api.ozibus.com.au/v1/newsletter
Subscribe a contact
Creates a consent record inside the authenticated merchant and verified source-domain boundary.
Headers
Merchant-Id: the Ozibus merchant ID.Api-KeyorX-Api-Key: a server-side secret key beginning withsk_.Content-Type: application/json.
JSON body
{"firstname":"Hugh","lastname":"Ifeanyichukwu","subscription_email":"hughi.obeni@gmail.com","source_domain_id":"587980a6-d5f1-45fe-a9cf-4c3ededd02f1","tags":[]}source_domain_id is the reference of a verified domain owned by the merchant, not the hostname. Never expose the secret key in browser code.
GET
/v1/newsletter
Request to /v1/newsletter
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 |
|---|---|---|---|
| firstname | string | Yes | |
| lastname | string | Yes | |
| subscription_email | string | Email address | Yes |
| source_domain_id | string | Yes | |
| tags | object | Yes |
Was this page useful?Your response helps us improve the developer journey.