Update a user profile
⚠️
Preview — this feature is being built; the design below is the spec.
PATCH https://app.syntic.ai/v1/user_profiles/{profile_id}Change a profile. attributes are merged key by key and a key set to null is removed. Running sessions see the new values from their next turn.
For how this fits into a full workflow, see User profiles.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <key>: a private inference key (sk_live_...). See Authentication. |
syntic-beta | Yes, while in preview | agents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Description |
|---|---|---|
profile_id | string | The profile id (uprof_...), or ext: followed by your external_id. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
display_name | string | No | Up to 120 characters. |
locale | string | No | BCP 47, for example de-DE. |
timezone | string | No | IANA zone, for example Asia/Dubai. |
attributes | object | No | Up to 50 keys; keys up to 64 characters, string values up to 512. |
memory_scope | string | No | Default user:<external_id>. |
Response
200 OK, Content-Type: application/json
{
"id": "uprof_01JCF5H7K9M1P3R5T7V9",
"type": "user_profile",
"external_id": "cust-4821",
"display_name": "Dana Lee",
"locale": "fr-FR",
"timezone": "Europe/London",
"attributes": {
"plan": "platinum"
},
"memory_scope": "user:cust-4821",
"session_count": 17,
"created_at": "2026-10-02T09:00:00Z",
"updated_at": "2026-11-05T10:00:00Z"
}| Field | Type | Description |
|---|---|---|
id | string | Starts with uprof_. |
external_id | string | Your own id for the person; unique within the workspace. |
locale | string | BCP 47 tag. The agent is told to answer in this language unless the user writes in another. |
timezone | string | IANA zone. Used for dates in the agent’s context and for deployment schedules that run per user. |
attributes | object | Up to 50 keys, string, number or boolean values. Visible to the agent as facts about the user. |
memory_scope | string | The scope used when agents read or write memories about this person. |
session_count | integer | Sessions started with this profile. |
Examples
curl -sS -X PATCH "https://app.syntic.ai/v1/user_profiles/uprof_01JCF5H7K9M1P3R5T7V9" \
-H "Authorization: Bearer $SYNTIC_API_KEY" \
-H "syntic-beta: agents-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"locale": "fr-FR",
"attributes": {
"plan": "platinum",
"region": null
}
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 404 | not_found_error | user_profile_not_found | No profile with this id or external id in the workspace. |
| 401 | authentication_error | invalid_api_key | The key is missing, unknown, revoked or expired. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?