Skip to main content
POST
cURL

Notes

Resubscribes a lead to one or more channels they previously unsubscribed from. Pass a channels array (sms, voice, email) in the request body to target specific channels. When channels is omitted, Apten resubscribes every channel the lead can actually receive: SMS and voice if the lead has a phone number, email if the lead has an email address. The 200 response channels array is the set that was applied, not the set that was requested. A lead with a phone number and no email who sends {} is resubscribed on SMS and voice, and the response is ["sms", "voice"]. If every requested channel is missing on the lead, the request fails with a 400. An explicit {"channels":["email"]} on a lead with no email returns Lead has no email. An explicit request that includes at least one reachable channel still succeeds for those channels. SMS carrier blocks. Leads who opted out of texting with a default keyword (e.g. “STOP”, “UNSUBSCRIBE”, “CANCEL”, “END”, “QUIT”, “STOP ALL”) are blocked at the carrier level and cannot be resubscribed to SMS through the API — they can only rejoin by texting “START”. Leads who unsubscribed via Apten’s smart-unsubscribe feature or user-defined custom unsubscribe keywords can be resubscribed normally. When SMS is carrier-blocked, any other requested channels are still processed; if SMS was the only requested channel, the request fails with a 400. Side effects:
  • Clears the lead’s do-not-contact status, if set.
  • Removes the lead’s phone number from your Do Not Contact (DNC) list when SMS is resubscribed.
  • Emits an opt-in webhook event for each channel that transitions from unsubscribed to subscribed.
This API does not change whether Apten is on for the lead. If you previously turned the lead off, also call Turn on a lead to resume messaging.

Authorizations

x-api-key
string
header
required

Path Parameters

leadId
string
required

The ID of the lead to resubscribe.

Body

application/json

Channels to resubscribe. Optional; when omitted, defaults to every channel the lead can receive.

channels
enum<string>[]

The channels to resubscribe the lead to. When omitted, Apten resubscribes every channel the lead can receive (phone → sms and voice, email → email).

Minimum array length: 1
Available options:
sms,
voice,
email

Response

Lead resubscribed successfully.

message
string

Returns "Lead resubscribed successfully." if the lead was resubscribed.

channels
enum<string>[]

The channels that were applied. Channels the lead cannot receive (no phone or no email) are omitted. SMS may also be omitted when the lead is blocked at the carrier level.

Available options:
sms,
voice,
email