Skip to main content

PreferenceItem

categorystringrequired

Possible values: [agent, agent_kyc, referral, commission, payment, subscription, auth, compliance, system, marketing]

channelstringrequired

Possible values: [email, sms, whatsapp, in_app]

enabledbooleanrequired
purposestring

Possible values: non-empty and <= 60 characters, Value must match regular expression PURPOSE_REGEX

Example: default
PreferenceItem
{
"category": "agent",
"channel": "email",
"enabled": true,
"purpose": "default"
}