The response schema for the communication consent API includes the application ID associated with the transaction, the user's identity, and the channels of communication.
Fields
app_id
StringThe ID of the sales channel where the user has given their consent. Example: "000000000000000000000004".
channels
ChannelsThe schema for all the communication channels that the user has accepted to receive communication through. Contains preferences for email, SMS, and WhatsApp channels.
user_id
StringIdentifier which can uniquely identify the user. Example: "5e56021c4bda3ccab6d9f884".
encrypted
BooleanWhether the communication consent is encrypted or not. Indicates if PII data (email, phone numbers) is stored encrypted. Data is decrypted before being returned in API responses. Defaults to false. Example: false.
Was this section helpful?