Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

leadId
string
required

The ID of the lead to add context to.

Body

application/json

The lead's context and an optional command.

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

Context has successfully been added to the lead.

message
string

Returns "Success" if the context was added successfully.