Retrieve user profile settings
/settings/user-profileReturns 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. Send this value in the If-Match header when updating these settings to avoid overwriting a newer version.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/settings/user-profile"{ "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" } }}Update security settings PATCH
Updates the content protection 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. Provider credentials are write-only. Enabling a video provider requires its credentials. 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.
Update user profile settings PATCH
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.