Custom conversation and visitor data fields
Custom conversation and visitor data fields
POST Create a multilingual custom field definition — Creates one stable organization-scoped custom field definition for conversations or visitors.DELETE Delete a custom field definition — Permanently deletes one organization-owned custom field definition, including localized labels and select options.GET List localized custom field definitions — Returns every organization-owned custom field definition resolved for the requested locale.PATCH Set stable custom field values on a conversation — Merges validated values into one organization-owned conversation's metadata.customFields object.PATCH Update multilingual custom field content — Partially updates one organization-owned custom field. The stable field name, type, and target are not changed; supplied translations or select options…Was this page helpful?
Update a tag definition
Updates the name, color, or both for one tag definition in the current organization. Renaming a definition also renames matching tags already assigned to conversations. Existing duplicate target tags are merged safely. The route returns `404` when the definition does not exist and `409` when another definition already uses the requested name.
Create a multilingual custom field definition
Creates one stable organization-scoped custom field definition for conversations or visitors. Field names are immutable API keys, select fields require localized options, and every label/placeholder/validation message is stored as locale lifecycle content. Access requires an active organization administrator session or an organization API key with the `custom-fields:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.