Update a contact

Endpoint

PATCH https://api.dairo.app/v1/contacts/{contactId}

Partially updates a contact and returns the updated record without its handles. Every field is optional; send only what changes. The nullable fields alias, info, and avatarUrl use explicit-null semantics — pass null to clear a value, or omit the key to leave it untouched. Existence is checked first, so a patch matching nothing returns 404 instead of a silent success, and reusing another contact's alias returns 409. Requires the contacts:write scope.

Scope: contacts:write. Send the API key as a bearer token; Scopes lists what each one reaches.

Request

cURL

curl -X PATCH "https://api.dairo.app/v1/contacts/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $DAIRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Path parameters

Name	Type	Required	Description
`contactId`	string	yes	The contact's ID.

Body

Required, application/json: ContactUpdateRequest.

Field	Type	Required	Description
`displayName`	string	no	(min length 1, max length 200)
`alias`	string or null	no
`kind`	`"person"`, `"agent"`, `"self"`	no
`info`	string or null	no	(max length 10000)
`avatarUrl`	string or null	no
`metadata`	object	no

Response

200 Success. Body: application/json, ContactDetailResponse.

Field	Type	Required	Description
`contact`	Contact	yes

200

{
  "contact": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "alias": null,
    "displayName": "string",
    "kind": "person",
    "isSelf": true,
    "info": null,
    "metadata": {},
    "avatarUrl": null,
    "handles": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "channel": "string",
        "value": "string",
        "label": "production",
        "isPrimary": true,
        "verified": true,
        "metadata": {},
        "createdAt": "2026-10-19T09:30:00Z",
        "updatedAt": "2026-10-19T09:30:00Z"
      }
    ],
    "createdAt": "2026-10-19T09:30:00Z",
    "updatedAt": "2026-10-19T09:30:00Z"
  }
}

Errors

Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.

Status	Meaning
`400`	The request is malformed or a value is invalid (`invalid_request`, `invalid_domain`, `idempotency_key_mismatch`).
`401`	The API key is missing or invalid.
`403`	The key lacks the scope this endpoint needs (`scope_missing`) or may not do this (`not_permitted`).
`404`	No such resource in this account (`resource_not_found`).
`422`	The request is well-formed but a field failed validation (`validation_failed`).
`429`	Rate limit, plan limit, budget or spend cap reached (`rate_limited`, `plan_limit_reached`, `budget_exceeded`, `spend_cap_reached`).
`500`	An unexpected error; retry with backoff, then contact support (`internal_error`).

Request

Path parameters

Body

Response

Errors

On this page