OmnioDocsAPI referenceOpen the app

Block contact

POST/v1/contacts/{customer_id}/block

Block a contact.

Its messages are stored and nothing is sent to it.

Scope contacts:write

Path parameters

customer_idstringRequired

Response

  • 200Success
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
  • 404not_found
  • 409contact_deleted
  • 422validation_error. details.fields names each field at fault

Every error has the same shape. See Errors.