v3

latestOpenAPI 3.0.32026-07-31135300306.1 KB

contacts

Create a new contact

Creates a new contact with the specified email and optional metadata.

Rate limit: 60 requests per minute

post/contacts

Request body

account_external_idstring

The external ID of the account that this contact belongs to. Cannot be used together with account_id.

account_idstring

The account that this contact belongs to.

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

emailstring

The email of the contact.

namestring required

The name of the contact.

phone_numbersstring[]

The phone numbers of the contact. Must contain only digits 0-9 and be 15 digits or less.

portal_role'no_access' | 'member' | 'admin'

The portal role to assign to the contact. If not provided uses the default portal role from the portal settings.

portal_role_idstring

The ID of the custom portal role to assign to the contact. Takes precedence over portal_role if provided.

primary_phone_numberstring

The primary phone number. Must be in the list of phone_numbers. If there are any phone_numbers and this is not specified, the first phone number will be primary.

Response

request_idstring

The request ID for tracking.