Skip to main content
PATCH
/
v2
/
contacts
/
{id}
cURL
curl --request PATCH \
  --url https://api.orq.ai/v2/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "Jane Smith",
  "email": "[email protected]",
  "avatar_url": "https://example.com/avatars/jane-smith.jpg",
  "tags": [
    "premium",
    "beta-user",
    "enterprise"
  ],
  "metadata": {
    "department": "Engineering",
    "role": "Senior Developer",
    "subscription_tier": "premium",
    "last_login": "2024-01-15T10:30:00Z"
  }
}
'
{
  "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "external_id": "user_12345",
  "display_name": "Jane Smith-Wilson",
  "email": "[email protected]",
  "avatar_url": "https://example.com/avatars/jane-smith.jpg",
  "tags": [
    "premium",
    "beta-user",
    "enterprise"
  ],
  "metadata": {
    "department": "Engineering",
    "role": "Senior Developer",
    "subscription_tier": "enterprise",
    "last_updated": "2024-01-15T10:30:00Z"
  },
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-16T14:45:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique contact id or external id

Body

application/json

Contact fields to update

​
display_name
string | null

Display name or nickname of the contact user. This is typically shown in user interfaces.

Example:

"Jane Smith"

​
email
string<email> | null

Email address of the contact user

Example:

"[email protected]"

​
avatar_url
string<uri> | null

URL linking to the contact user's avatar image

Example:

"https://example.com/avatars/jane-smith.jpg"

​
tags
string[]

Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.

Example:
["premium", "beta-user", "enterprise"]
​
metadata
object

Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.

Example:
{
  "department": "Engineering",
  "role": "Senior Developer",
  "subscription_tier": "premium",
  "last_login": "2024-01-15T10:30:00Z"
}

Response

Updated contact

​
_id
string<ulid>
required

Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact

Example:

"contact_01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
external_id
string
required

Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.

Required string length: 1 - 120
Example:

"user_12345"

​
display_name
string | null

Display name or nickname of the contact user. This is typically shown in user interfaces.

Example:

"Jane Smith"

​
email
string<email> | null

Email address of the contact user

Example:

"[email protected]"

​
avatar_url
string<uri> | null

URL linking to the contact user's avatar image

Example:

"https://example.com/avatars/jane-smith.jpg"

​
tags
string[]

Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.

Example:
["premium", "beta-user", "enterprise"]
​
metadata
object

Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.

Example:
{
  "department": "Engineering",
  "role": "Senior Developer",
  "subscription_tier": "premium",
  "last_login": "2024-01-15T10:30:00Z"
}
​
created
default:2025-12-08T10:34:25.077Z

The date and time the resource was created

​
updated
default:2025-12-08T10:34:25.079Z

The date and time the resource was last updated