Ingress Callback
- Alexander Conroy
This API allows you to set a Callback for a Lead and Specify that the callback is either Global or assigned to a specific user. This can be useful when working with third party forms or platforms that gather data related to an already existing client and schedules a callback. Applications like Calendly fit this use-case. Please note that this is not an automated callbacks but it adds a record to the Callbacks for a particular user and lead that should be manually followed up with at the designated time.
Endpoint: /api/ingress/callback
Method: POST
API Version Support: v1
Security Notice: Please make sure to use API | Endpoint Protection when giving this access to third party systems as API Keys are unprotected unless specified.
The proper endpoint protection to set for an API using this Endpoint is /api/ingress/callbacks
Data Formats Supported
form-data, x-www-form-urlencoded Form Parameters or JSON Body with Content-Type: application/json set.
Response Codes
200: Success and Warnings
400: Error
Parameter | Required | Format | Description |
|---|---|---|---|
| ✓ | int | A Valid Lead ID. |
| ✓ | datetime | The Date and Time the Callback should be performed. The timezone should be the accounts default timezone. |
| ✘ | int | Valid TLD User to be designated as the Callback Creator. Default 0 (System) |
| ✘ | int | Valid TLD User Responsible to do the Callback. Default 0 (System) |
| ✘ | string | General Description of the Callback Reason. |
| ✘ | int | Valid Lead Status. Will Trigger Lead Disposition Functions except for hangup, pause, validations and policy conversions. |
JSON Request Object
{
"lead_id": 3838036,
"callback": "2024-05-10 13:12:00",
"description": "Wants Quote",
"status_id": 5
}JSON Success Object
{
"lead_id": "3838036",
"user_id": 0,
"message": "Added Callback.",
"result": "51940"
}JSON Error Object
{
"error": "Lead does not exist."
}Errors Possible
Error | Resolution |
|---|---|
No API ID Provided | Check API ID in Header or Parameters. See API | Using API ID and API Key |
No API Key Provided | Check API Key in Headers or Parameters. See API | Using API ID and API Key |
No lead selected. | Check |
Lead does not exist. | Check |
Error adding callback. | Check |