Resubscribe a lead

POST

leads

{leadId}

resubscribe

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/resubscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channels": [
    "sms"
  ]
}
'

import requests

url = "https://api.attent.app/v1/leads/{leadId}/resubscribe"

payload = { "channels": ["sms"] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({channels: ['sms']})
};

fetch('https://api.attent.app/v1/leads/{leadId}/resubscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/leads/{leadId}/resubscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channels' => [
        'sms'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/leads/{leadId}/resubscribe"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"sms\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.attent.app/v1/leads/{leadId}/resubscribe")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channels\": [\n    \"sms\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/leads/{leadId}/resubscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channels\": [\n    \"sms\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Lead resubscribed successfully.",
  "channels": [
    "sms"
  ]
}

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"]. When SMS consent cannot be completed, requests that include other available channels still succeed for those channels. The response is 200, channels lists only the channels successfully resubscribed, and failedChannels lists the channels that could not be resubscribed, including whether the failure is retryable. For an SMS-only request, the API returns 502 or 503. SMS remains unsubscribed, and no SMS opt-in event or phone-number DNC removal is applied. 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. 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, potentially with partial success.

message

string

Returns "Lead resubscribed successfully." when all requested channels are resubscribed, or "Lead resubscribed with partial success." when one or more channels could not be resubscribed.

channels

enum<string>[]

The channels that were applied. Channels the lead cannot receive (no phone or no email) are omitted.

Available options:

sms,

voice,

email

failedChannels

object[]

Channels that could not be resubscribed. Present only when the response is a partial success.

Show child attributes

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/resubscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channels": [
    "sms"
  ]
}
'

import requests

url = "https://api.attent.app/v1/leads/{leadId}/resubscribe"

payload = { "channels": ["sms"] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({channels: ['sms']})
};

fetch('https://api.attent.app/v1/leads/{leadId}/resubscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/leads/{leadId}/resubscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channels' => [
        'sms'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/leads/{leadId}/resubscribe"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"sms\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.attent.app/v1/leads/{leadId}/resubscribe")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channels\": [\n    \"sms\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/leads/{leadId}/resubscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channels\": [\n    \"sms\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Lead resubscribed successfully.",
  "channels": [
    "sms"
  ]
}

API Reference

Leads

Calls

Tags

Usage

Do Not Contact

Resubscribe a lead

Notes

Authorizations

Path Parameters

Body

Response

​Notes

Authorizations

Path Parameters

Body

Response

Notes