Create New Contact

Create a new contact for a given phone number.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

Request payload for creating a new contact record.
phoneNumberstringRequired
Phone number to save for your contact, in E.164 format.
descriptionstring or nullOptional
New notes or details for your contact.
emailstring or nullOptional
New email address for your contact.
namestring or nullOptional
New name for your contact.
tagslist of stringsOptional
New tags for your contact.

Response

Successfully created the contact.
idstring

Unique ID of the created contact. This identifier is a string that always begins with the prefix co_, for example: co_1234567890.

Errors