Leads
Add context to a lead
Leads
Add context to a lead
Adds context to a lead
POST
/
leads
/
{leadId}
/
addContext
Authorizations
x-api-key
string
headerrequiredPath Parameters
leadId
string
requiredThe ID of the lead to add context to.
Body
application/json
context
string
Additional context to add to the lead. Good for adding free-form text context or event details.
additionalInfo
object
An key-value object containing structured data to store with the lead. These will be stored as variables that can be accessed in the flow-chart conversation prompts.
command
string
An optional command for Apten regarding the lead. Currently allowed commands are scheduling a follow up and sending a message.
Response
200 - application/json
message
string
Returns "Success" if the context was added successfully.