Consent

Can this brand message this number?

Without this the only way to learn someone opted out is to attempt a send and read the 409 — which means finding out at the moment you were going to message them.

get/v1/brands/{id}/optins/{e164}

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/brands/{id}/optins/{e164}
  • Auth: HTTP bearer

Path parameters

idstring required

Brand id.

e164string required

Recipient in E.164, URL-encoded (%2B12025550123).

Response

Consent status.

e164string required
status'opted_in' | 'opted_out' | 'no_record' required
sendableboolean required

Whether a send would be accepted right now.

methodstring

How consent was captured.

evidenceRefstring nullable
capturedAtstring nullable
optedOutAtstring nullable
reconsentsnumber

How many times this opt-out has already been reversed.

remediationstring
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.