v1

latestOpenAPI 3.0.02026-07-1313126.3 KB

contact

Create contact

This endpoint allows you to create a new Contact. A contact represents a person with whom you can interact via a phone call or other communication.

post/contact/create

Request body

phone_numberstring required

The phone number of the Contact. This is required to initiate calls.

namestring

The name of the Contact.

emailstring

The email address associated with the Contact (optional).

country_codestring

The country code for the Contact's phone number.

tagsstring[]

Tags associated with the Contact to help categorize or segment them.

attributesobject

Custom attributes you can assign to the Contact. These can be referenced in the Agent script.

Response

Successful response

errorobject nullable

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

dataobject required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.