Leads

Switch lead's customer profile

Switches the customer profile of a lead. The lead’s variables and conversation history are kept unless clearMemory is true, and the flowchart restarts at the new profile’s starting node. What happens to the lead’s scheduled messages depends on followUps. With followUps: "restart" (the default), pending scheduled follow-ups (automated follow-up steps, dynamic AI-scheduled follow-ups, etc.) are canceled and the follow-up lead resets to step 1 of the new profile’s cadence (nothing is scheduled by the reset itself). Manually scheduled messages (created via “Schedule Message” in the dashboard) are preserved. If sendMessage is true, a new first message for the new profile is scheduled in their place (see sendMessage below); if sendMessage is false (the default), nothing is scheduled, so the lead has no pending follow-up until its next interaction. With followUps: "continue", callbacks, reminders, manual messages, and user-scheduled follow-ups are kept, and a lead not contacted yet gets its first message under the new profile; see followUps below.

POST

leads

{leadId}

switchCustomerProfile

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/switchCustomerProfile \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "profile": "<string>",
  "sendMessage": true,
  "messageDelayHours": 123,
  "messageDelayMins": 123,
  "clearMemory": true,
  "followUps": "restart"
}
'

import requests

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

payload = {
    "profile": "<string>",
    "sendMessage": True,
    "messageDelayHours": 123,
    "messageDelayMins": 123,
    "clearMemory": True,
    "followUps": "restart"
}
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({
    profile: '<string>',
    sendMessage: true,
    messageDelayHours: 123,
    messageDelayMins: 123,
    clearMemory: true,
    followUps: 'restart'
  })
};

fetch('https://api.attent.app/v1/leads/{leadId}/switchCustomerProfile', 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}/switchCustomerProfile",
  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([
    'profile' => '<string>',
    'sendMessage' => true,
    'messageDelayHours' => 123,
    'messageDelayMins' => 123,
    'clearMemory' => true,
    'followUps' => 'restart'
  ]),
  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}/switchCustomerProfile"

	payload := strings.NewReader("{\n  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\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}/switchCustomerProfile")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\n}"

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

{
  "message": "Switched profile successfully.",
  "sendMessage": true,
  "messageDelayHours": 0,
  "messageDelayMins": 30,
  "followUps": "restart"
}

Authorizations

x-api-key

string

header

required

Path Parameters

leadId

string

required

The ID of the lead to switch the customer profile for.

Body

application/json

The new customer profile to switch the lead to.

profile

string

required

The name of the new customer profile to switch the lead to.

sendMessage

boolean

Whether to send the new profile's first message to the lead after switching. Defaults to false. When false, no first message is scheduled for the new profile, so the switch does not automatically initiate contact. With followUps: "restart", the existing pending follow-up (if any) is also canceled. Must be false or omitted when followUps is continue. When true, the first message is scheduled after the delay in messageDelayHours / messageDelayMins below; if both are omitted (or 0), the message is sent immediately, subject only to outreach-hours/holiday adjustment.

messageDelayHours

integer

The number of hours to wait before sending the message. Takes precedence over messageDelayMins.

messageDelayMins

integer

The number of minutes to wait before sending the message. Used as an alternative to messageDelayHours.

clearMemory

boolean

Whether to clear the AI's memory of the existing conversation with the lead. Defaults to false.

followUps

enum<string>

default:restart

What happens to the lead's scheduled messages and follow-up cadence when the profile changes. restart (default) deletes the first-message schedule, cancels all pending scheduled messages except manual ones, and resets the lead to step 1 of the new profile's cadence (follow-ups stop if the new profile has follow-ups disabled). The reset schedules nothing by itself: with sendMessage false the lead has no pending outreach until its next interaction, and with sendMessage true the new profile's first message goes out after the delay and the cadence continues from there. continue keeps AI-scheduled messages (callbacks, call reminders, event reminders), manual messages, follow-ups a user scheduled for a date, and the first-message schedule, and replaces the pending automated follow-up with step 1 of the new profile's cadence, starting now. If one of the kept messages is pending, no automated follow-up is added; the cadence continues from step 1 after it sends. A lead not contacted yet gets its first message under the new profile. Stopped leads and leads in long-term follow-up are left as they are, and only the profile changes. If the new profile has follow-ups disabled, automated follow-ups are canceled and follow-ups stop, even for long-term leads. continue can't be combined with sendMessage: true (returns 400), and an unknown value also returns 400. Use continue to switch a lead after a call without losing a callback the lead booked.

Available options:

restart,

continue

Response

200 - application/json

Customer profile of lead switched successfully.

message

string

sendMessage

boolean

messageDelayHours

integer

messageDelayMins

integer

followUps

enum<string>

The follow-ups mode that was applied.

Available options:

restart,

continue

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/switchCustomerProfile \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "profile": "<string>",
  "sendMessage": true,
  "messageDelayHours": 123,
  "messageDelayMins": 123,
  "clearMemory": true,
  "followUps": "restart"
}
'

import requests

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

payload = {
    "profile": "<string>",
    "sendMessage": True,
    "messageDelayHours": 123,
    "messageDelayMins": 123,
    "clearMemory": True,
    "followUps": "restart"
}
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({
    profile: '<string>',
    sendMessage: true,
    messageDelayHours: 123,
    messageDelayMins: 123,
    clearMemory: true,
    followUps: 'restart'
  })
};

fetch('https://api.attent.app/v1/leads/{leadId}/switchCustomerProfile', 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}/switchCustomerProfile",
  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([
    'profile' => '<string>',
    'sendMessage' => true,
    'messageDelayHours' => 123,
    'messageDelayMins' => 123,
    'clearMemory' => true,
    'followUps' => 'restart'
  ]),
  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}/switchCustomerProfile"

	payload := strings.NewReader("{\n  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\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}/switchCustomerProfile")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"profile\": \"<string>\",\n  \"sendMessage\": true,\n  \"messageDelayHours\": 123,\n  \"messageDelayMins\": 123,\n  \"clearMemory\": true,\n  \"followUps\": \"restart\"\n}"

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

{
  "message": "Switched profile successfully.",
  "sendMessage": true,
  "messageDelayHours": 0,
  "messageDelayMins": 30,
  "followUps": "restart"
}

API Reference

Leads

Calls

Tags

Usage

Do Not Contact

Switch lead's customer profile

Authorizations

Path Parameters

Body

Response