POST
/
leads
/
{leadId}
/
sendMessage

Authorizations

x-api-key
string
headerrequired

Path Parameters

leadId
string
required

The ID of the lead to send a message to.

Body

application/json
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.

Response

200 - application/json
message
string

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

Look up lead by phone