API reference · Contacts
POST/api/v1/contacts

Create contact

Inherited ApiBaseController create route for contacts.

RBAC · contact

Request body

Content type: application/json · schema ContactBody

full_namestringRequired
min length 1 · max length 255
client_idstring <uuid>
phone_numbersarray of object
itemsobject
emailstring <email>Required
primary_email_canonical_typestringNullable
primary_email_custom_typestringNullable
primary_email_custom_type_idstring <uuid>Nullable
additional_email_addressesarray of object
itemsobject
rolestring
notesstring
is_inactiveboolean
tagsarray of string
itemsstring

Response body

Success response 201 · schema ClientContactEnvelope

dataobjectRequired
contact_name_idstring <uuid>Required
full_namestringRequired
client_idstring <uuid>RequiredNullable
emailstring <email>Required
rolestringRequiredNullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
is_inactivebooleanRequired
tenantstring <uuid>Required
phone_numbersarray of object
itemsobject
contact_phone_number_idstring <uuid>Required
phone_numberstringRequired
normalized_phone_numberstringRequired
canonical_typestringNullable
custom_phone_type_idstring <uuid>Nullable
custom_typestringRequiredNullable
is_defaultbooleanRequired
display_orderintegerRequired
≥ 0
additional_email_addressesarray of object
itemsobject
contact_additional_email_address_idstring <uuid>Required
email_addressstring <email>Required
normalized_email_addressstring <email>Required
canonical_typestringNullable
custom_email_type_idstring <uuid>Nullable
custom_typestringRequiredNullable
display_orderintegerRequired
≥ 0
default_phone_numberstringNullable
default_phone_typestringNullable
primary_email_canonical_typestringNullable
primary_email_custom_type_idstring <uuid>Nullable
primary_email_typestringNullable
notesstringNullable
avatarUrlstringNullable
tagsarray of string
itemsstring
client_namestringNullable
metaobject

Response codes

201
Contact created.
400
Invalid request payload.
401
API key missing/invalid or key user not found.
403
Permission denied for contact create.
500
Unexpected contact creation failure.