Inquirly

Update a contact

PATCH

/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Contacts API

Update a contact's attributes

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/public/api/v1/inboxes//contacts/' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "identifier": "string",
    "identifier_hash": "string",
    "email": "string",
    "name": "string",
    "phone_number": "string",
    "avatar_url": "string",
    "custom_attributes": {}
}'

Response Example

200 - Example 1

{
    "id": 0,
    "source_id": "string",
    "name": "string",
    "email": "string",
    "pubsub_token": "string"
}

Request

Path Params

inbox_identifier

string

required

contact_identifier

string

required

Body Params application/json; charset=utf-8

identifier

string

optional

External identifier of the contact

identifier_hash

string

optional

Identifier hash prepared for HMAC authentication

string

optional

Email of the contact

name

string

optional

Name of the contact

phone_number

string

optional

Phone number of the contact

avatar_url

string

optional

The url to a jpeg, png file for the user avatar

custom_attributes

object

optional

Custom attributes of the customer

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

integer

optional

Id of the contact

source_id

string

optional

The session identifier of the contact

name

string

optional

Name of the contact

string

optional

Email of the contact

pubsub_token

string

optional

The token to be used to connect to chatwoot websocket

🟠401Unauthorized

Get a contact

Create a conversation