SMS

Get a contact's SMS consent

Read a contact's current SMS consent state and the full immutable consent history — what was agreed to, when, and from which source. Use this to answer a carrier or regulator asking you to prove a recipient opted in, without contacting support. marketing_eligible is the field that decides whether marketing SMS to this contact will be accepted. Requires the contacts:read capability.

get/contacts/{id}/sms-consent

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/contacts/{id}/sms-consent
  • Auth: HTTP bearer

Response

The consent state and history.

object'sms_consent' required
phonestring nullable required
countrystring nullable
statusstring required
marketing_eligibleboolean
consented_atstring nullable
consent_sourcestring nullable
consent_purposestring nullable

Changes

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