Developers
Access and sign-up8

Update user profile settings

PATCH/settings/user-profile

Updates the user profile settings. Only the fields included in the request are changed: setting a field to null clears its configured value and restores the default, and omitted fields are left unchanged.

To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header. The header is optional; when it is omitted, the update is applied to the current revision.

Authorization

AuthorizationBearer <token>

Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Controls which profile fields students can see or edit and how student names appear in support tools.

Omitted fields remain unchanged. Only fields explicitly documented as nullable accept null.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/settings/user-profile" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "custom_fields_url": "string",    "defaults": {},    "display": {      "full_name_in_support": true    },    "object": "settings",    "profile": {      "hide_address": true,      "hide_document": true,      "hide_phone": true,      "lock_editing": true,      "lock_email": true    },    "propagation": {},    "replica": {},    "revision": "string",    "signup_form": {      "embed_url": "string"    }  }}

Retrieve user profile settings GET

Returns the user profile settings of the account: which profile fields users can view or edit, and whether their full name is displayed in support conversations. The response includes an `ETag` representing the current revision of these settings; changes to other settings groups do not affect it. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.

Email settings7

Next Page