Consent Update API

post

https://api.in.kaleyra.io/v1/{sid}/consent

The Kaleyra platform allows you to grant or revoke consent options to an end-customer based on channel and sender ID. This API allows you to send the option to your end-users to provide consent to your sender ID either using Opt-In or Opt-Out, based on regional regulations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Account SID (Security Identifier). For more information, see View API Key and SID.

Body Params

channel

string

required

Channel name for which you want to update the consent. Example - sms.

sender_identifier

string

required

Inbound Sender ID. In case of SMS, it’s the short code for customers.

contact_identifier

string

required

Contact identifier of the end-user or end-user's mobile number.

consent_category

string

Consent category. Example - Marketing, Transactional, or Promotional.

consent_topic

string

Consent topic. Example - Offers, Loan, or Insurance.

source

string

required

Source of the consent request or source of opt-in or opt-out. Example - API.

source_identifier

string

Unique identifier for the source request. Example - MO_id. The MO_id is the identifier stored on the SMS database.

timestamp

date-time

Timestamp when the event occurred in ISO Date format (YYYY-MM-DDThh:mm:ss).

consent_status

string

required

Status of consent. Example - OPT_IN or OPT_OUT.

inbound_message_identifier

string

Inbound sender_id to which end-user is sending opt-in or opt-out message to. It will be the sender ID of the incoming MO.

request_identifier

string

Unique request ID from Kaleyra from where the consent API is triggered.

x_callback_url

string

Callback URL to receive updates on processing.

Headers

api-key

string

required

API key generated from the Kaleyra platform account. For more information, see View API Key and SID.

Responses

202Accepted

400Bad Request

401Unauthorized

500Internal Server Error