Skip to main content
PATCH
/
v1
/
identities
/
{identity_id}
Update identity
curl --request PATCH \
  --url https://api.example.com/v1/identities/{identity_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "reply_to_email": "<string>",
  "signature_text": "<string>",
  "signature_html": "<string>",
  "thread_history_depth": 123,
  "approval_channel": {},
  "status": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "local_part": "<string>",
  "email_address": "<string>",
  "display_name": "<string>",
  "reply_to_email": "<string>",
  "signature_text": "<string>",
  "signature_html": "<string>",
  "thread_history_depth": 123,
  "status": "<string>",
  "approval_channel": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
identity_id
string<uuid>
required

Body

application/json
​
assistant_id
string<uuid> | null
​
display_name
string | null
​
reply_to_email
string | null
​
signature_text
string | null
​
signature_html
string | null
​
thread_history_depth
integer | null
​
approval_channel
Approval Channel · object
​
status
string | null

Response

Successful Response

​
id
string<uuid>
required
​
workspace_id
string<uuid>
required
​
domain_id
string<uuid>
required
​
assistant_id
string<uuid> | null
required
​
local_part
string
required
​
email_address
string
required
​
display_name
string
required
​
reply_to_email
string | null
required
​
signature_text
string | null
required
​
signature_html
string | null
required
​
thread_history_depth
integer
required
​
status
string
required
​
approval_channel
Approval Channel · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required