Custom Fields

Custom conversation and visitor data fields

EndpointsCopy Anchor Link

• POST Create a multilingual custom field definition — Creates a custom field definition for conversations or visitors in the authenticated organization. Field names are immutable API keys.
• DELETE Delete a custom field definition — Permanently deletes a custom field definition, including its 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 a conversation's metadata.customFields object.
• PATCH Update multilingual custom field content — Partially updates a custom field definition. The field name, type, and target cannot change.