Skip to main content
PATCH
/
profiles
/
{id}
Update profile.
curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "salutation": "formal_male",
  "name": "John Doe",
  "gender": "undisclosed",
  "blocked": true,
  "date_of_birth": "1970-01-01",
  "phone_number": "+4915224367929",
  "email": "jsmith@example.com",
  "address": "<string>",
  "custom_1": "<string>",
  "custom_2": "<string>",
  "custom_3": "<string>",
  "custom_4": "<string>",
  "custom_5": "<string>",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}'
{
  "data": {
    "id": 123,
    "salutation": "formal_male",
    "name": "John Doe",
    "gender": "undisclosed",
    "blocked": true,
    "date_of_birth": "1970-01-01",
    "phone_number": "+4915224367929",
    "email": "jsmith@example.com",
    "address": "<string>",
    "custom_1": "<string>",
    "custom_2": "<string>",
    "custom_3": "<string>",
    "custom_4": "<string>",
    "custom_5": "<string>",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Body

application/json

Profile data of a customer. A profile can have many customers. A customer belongs to one profile. Can be used to connect a real person with multiple messengers (aka customers) to one profile.

​
id
integer
​
salutation
enum<string>
Available options:
formal_male,
formal_female,
informal
​
name
string
Example:

"John Doe"

​
gender
enum<string>
Available options:
undisclosed,
male,
female,
diverse
​
blocked
boolean

If a profile is blocked, receiving messages will be disabled.

​
date_of_birth
string<date-time> | null
Example:

"1970-01-01"

​
phone_number
string | null

Phone number in international format.

Example:

"+4915224367929"

​
email
string<email> | null
​
address
string | null
​
custom_1
string | null

One of five custom fields. Names of custom fields can be configured via settings.

​
custom_2
string | null
​
custom_3
string | null
​
custom_4
string | null
​
custom_5
string | null
​
created_at
string<date-time> | null

Datetime when profile was created.

Example:

"2023-01-01T12:00:00Z"

​
updated_at
string<date-time> | null

Datetime when profile was last updated.

Example:

"2023-01-01T12:00:00Z"

Response

200 - application/json

Success

​
data
object

Profile data of a customer. A profile can have many customers. A customer belongs to one profile. Can be used to connect a real person with multiple messengers (aka customers) to one profile.