OmnioDocsAPI referenceOpen the app

Create contact

POST/v1/contacts

Create a contact.

Without customer_id one is generated.

Scope contacts:writeIdempotency-Key optional

Request body

first_namestring
Up to 80 characters
last_namestring
Up to 80 characters
usernamestring
Up to 64 characters
phone_e164string
E.164, such as +237690000099
emailstring
Up to 254 characters
languagestring
attributesobject
customer_idstring
Up to 40 characters

Response

  • 201Success
Response fields
customer_idstringRequired
first_namestringRequired
May be null
last_namestringRequired
May be null
usernamestringRequired
May be null
phone_e164stringRequired
May be null
emailstringRequired
May be null
languagestringRequired
May be null
lifecycleobjectRequired
May be null
lifecycle.stage_idstringRequired
lifecycle.namestringRequired
lifecycle.colorstringRequired
tagsarray of objectRequired
tags[].idstringRequired
tags[].namestringRequired
tags[].colorstringRequired
collaboratorsarray of stringRequired
attributesobjectRequired
statusstringRequired
channel_idstringRequired
May be null
last_message_atstringRequired
May be null
last_message_previewstringRequired
May be null
created_atstringRequired
updated_atstringRequired
deleted_atstringRequired
May be null

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 409customer_id_taken, or idempotency_conflict
  • 422customer_id_invalid, or validation_error

Every error has the same shape. See Errors.