contacts-v2

Resubscribe a previously unsubscribed contact on a list

Requires consent proof (consent_method). Handles three-layer opt-out: our database, provider opt-out list, and carrier network.

post/v2/contacts/resubscribe

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/contacts/resubscribe
  • Auth: API key in header X-Api-Key

Request body

consent_languagestring

Exact disclosure text shown to consumer

consent_methodstring required

How consent was obtained: web_form, sms_keyword, mobile_app, verbal, written, api_with_proof, double_opt_in

consent_sourcestring

URL or description of consent capture point

ip_addressstring

IP address at time of consent

list_numberstring required

Sending list phone number in E.164 format

phone_numberstring required

Contact phone number in E.164 format

skip_journey_if_existsboolean

Skip journey enrollment if already enrolled

use_journeysboolean

Enroll contact in matching welcome journeys

user_agentstring

Browser/device user agent string

Response

Contact resubscribed

carrier_instructionsstring

Instructions for clearing carrier block (only when pending_start_keyword)

carrier_statusstring

Carrier status: cleared or pending_start_keyword

consent_statusstring

Consent status: re_opted_in

contact_idstring

Contact ID

journeys_enrolledinteger

Number of journeys enrolled

list_contact_idstring

ListContact ID

previous_unsub_datestring date-time

Previous unsubscribe date

previous_unsub_reasonstring

Previous unsubscribe reason

resubscribedboolean

Whether contact was resubscribed

successboolean

Operation success

Changes

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