POST
/
leads
/
{leadId}
/
sendMessage
curl --request POST \
  --url https://api.attent.app/v1/leads/{leadId}/sendMessage \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "message": "<string>",
  "scheduledTime": "<string>",
  "sendWhenOff": true,
  "scheduleFollowUps": true,
  "overrideBusinessHours": true
}'
{
  "message": "Message sent successfully."
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
leadId
string
required

The ID of the lead to send a message to.

Body

application/json
The message to send to the lead.
​
message
string
required

The content of the message to send to the lead.

​
scheduledTime
string

The date and time to schedule the message for. This should be in ISO 8601 format (e.g. 2024-05-17T21:09:13Z). If not provided, or if the scheduled time is in the past, the message will be sent immediately.

​
sendWhenOff
boolean

Whether to send the message even if Apten is turned off for the lead. Defaults to false.

​
scheduleFollowUps
boolean

Whether to schedule follow-up messages for this lead. Defaults to false.

​
overrideBusinessHours
boolean

Whether to send the message immediately regardless of business hours. If not provided or false, and no scheduledTime is specified, the message will be scheduled for the next business hours. Defaults to false.

Response

200
application/json
Message sent successfully.
​
message
string

Returns "Message sent successfully." if the message was sent.