Skip to main content

Worked request and response samples

Copy a request body as written, substitute your own ids, and compare the response envelope. Errors follow Devotel Orbit’s { error, meta } envelope, shown once below under Error envelope.

Check DNC status for a phone number

GET /api/v1/compliance/dnc/check
Returns whether the given E.164 phone number appears on any of your configured Do-Not-Call sources. When DNC sync is not enabled for your account, the request returns 403 DNC_SYNC_NOT_ENABLED. Request

Run a preflight check on a destination

POST /api/v1/compliance/10dlc/preflight
Scopes your brand and campaign throughput before you commit the 10DLC registration. Send neither brand nor campaign ids and the endpoint still returns the common fail-fast checks. Request

Record an opt-in or opt-out for a contact

POST /api/v1/compliance/consent
Identifies the contact by contact_id or a freeform identifier. An opt-in requires purpose and consent_text_version for proof. Request

Error envelope

422

DLT-India registration (gated writes)

DLT-India registration must be enabled for your account. The four DLT-India write endpoints — POST /compliance/dlt-india/principal-entities, POST /compliance/dlt-india/headers, POST /compliance/dlt-india/content-templates, and POST /compliance/dlt-india/consent-templates — return 503 FEATURE_DISABLED until DLT registration is enabled for your account. The matching GET endpoints stay available in every environment, so you can still read existing principal entities, headers, and templates while writes are disabled.A gated request returns:
503 Service Unavailable
If you receive this response, contact support to have DLT registration enabled for your account.