Turn off a lead

POST

leads

{leadId}

turnOff

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/turnOff \
  --header 'x-api-key: <api-key>'

{
  "message": "Lead turned off successfully."
}

x-api-key

string

header

required

leadId

string

required

The ID of the lead to turn off Apten for.

Apten has successfully been turned off for the lead.

message

string

Returns "Lead turned off successfully." if Apten was turned off for the lead.

cURL

curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/turnOff \
  --header 'x-api-key: <api-key>'

{
  "message": "Lead turned off successfully."
}

Documentation Index