Skip to main content

Custom Fields & Metadata

Project-configurable metadata: custom lead fields, custom activity types and their fields, tags, lead statuses, and call outcomes. All endpoints require a valid Bearer JWT and are scoped to the token's project_id.

Lead custom fields​

MethodPathDescription
GET/api/custom-fieldsList custom field definitions.
POST/api/custom-fieldsCreate a custom field definition.
PUT/api/custom-fields/{id}Update a custom field definition.
DELETE/api/custom-fields/{id}Delete a custom field definition.
GET/api/leads/{lead_id}/custom-fieldsGet a lead's custom field values.
PUT/api/leads/{lead_id}/custom-fieldsSet a lead's custom field values.

Custom activity types​

MethodPathDescription
GET/api/custom-activity-typesList custom activity types.
GET/api/custom-activity-types/{id}Fetch a custom activity type.
POST/api/custom-activity-typesCreate a custom activity type.
PUT/api/custom-activity-types/{id}Update a custom activity type.
DELETE/api/custom-activity-types/{id}Delete a custom activity type.

Custom activity fields​

MethodPathDescription
GET/api/custom-activity-types/{type_id}/fieldsList fields for a custom activity type.
POST/api/custom-activity-types/{type_id}/fieldsCreate a field on a custom activity type.
GET/api/custom-activity-fields/{id}Fetch a custom activity field.
PUT/api/custom-activity-fields/{id}Update a custom activity field.
DELETE/api/custom-activity-fields/{id}Delete a custom activity field.

Tags​

MethodPathDescription
GET/api/tagsList tags.
POST/api/tagsCreate a tag.
PUT/api/tags/{id}Update a tag.
DELETE/api/tags/{id}Delete a tag.
GET/api/leads/{lead_id}/tagsList a lead's tags.
POST/api/leads/{lead_id}/tagsAssign a tag to a lead.
DELETE/api/leads/{lead_id}/tags/{tag_id}Remove a tag from a lead.

Lead statuses​

MethodPathDescription
GET/api/lead-statusesList lead statuses.
GET/api/lead-statuses/{id}Fetch a lead status.
POST/api/lead-statusesCreate a lead status.
PUT/api/lead-statuses/{id}Update a lead status.
DELETE/api/lead-statuses/{id}Delete a lead status.
POST/api/lead-statuses/reorderReorder lead statuses.

Call outcomes​

Each call outcome's description is part of the prompt the AI uses to choose the outcome after a call — never leave it empty. How assignment works: Post-call outcomes.

MethodPathDescription
GET/api/call-outcomesList call outcomes.
GET/api/call-outcomes/{id}Fetch a call outcome.
POST/api/call-outcomesCreate a call outcome.
PUT/api/call-outcomes/{id}Update a call outcome.
DELETE/api/call-outcomes/{id}Delete a call outcome.