Documentation

Update a visitor

PATCH/v1/visitors/:id

Auth: Secret API key (rk_sk_)

Update server-trusted visitor data and attributes.

Path parameters

NameTypeDescription
idrequireduuidVisitor ID

Body parameters

NameTypeDescription
emailstringEmail address
namestringDisplay name
attributesobjectCustom attributes

Responses

200Updated visitor
{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "externalId": "usr_123",
  "email": "ada@example.com",
  "name": "Ada Lovelace",
  "attributes": {
    "plan": "pro"
  },
  "createdAt": "2026-01-04T10:00:00Z"
}