Skip to main content

Customer Consent Upload

You can grant or revoke a customer's consent to be contacted on a specific channel (an email address or phone number) in bulk. Drop the file in the /CustomerConsentUpload directory of your FTP home.

tip

To get started, download a sample file with the following consent updates.

info

Filename convention: YYYY-MM-DD-hh-mm-ss.csv

HeaderFormatDescription
CustomerRef *StringUnique value representing the customer in your system. Must match an existing customer.
ChannelType *Constant: Email or PhoneThe type of contact channel the consent decision applies to.
Channel *StringThe email address, or the phone number including country code, e.g.
+61444555666
Consent *Constant: Granted or RevokedThe consent decision for the channel.
ConsentRecordedAt *String data formatted as YYYY-MM-DD HH:MM:SS, in UTCWhen the customer made the decision in your system. Must not be in the future.

Processing rules

  • The newest decision wins: each row is applied as at ConsentRecordedAt, so a row that is older than, or the same age as, the decision we already hold for that channel is ignored. A row with the same timestamp but the opposite decision is rejected as a row error.
  • Revoking consent for a channel keeps the channel on record with consent revoked; it does not remove the channel from the customer.
  • Granting or revoking consent for a channel we don't have on record yet adds it to the customer.