Manage User Consent (Opt-in/Opt-out)

Use this API to register or update user consent for WhatsApp messaging. Supports opt-in and opt-out actions with full compliance tracking.

Opt-in Sources:

  • Website forms and checkboxes
  • Mobile app interfaces
  • SMS or IVR campaigns
  • Retail and contact center interactions
  • Session-based consent in WhatsApp

Compliance Tracking:

  • Capture consent source and timestamp
  • Log IP address and user agent
  • Maintain records for audits

Use Cases:

  • Marketing opt-ins (promotions, newsletters)
  • Transactional messages (order updates, alerts)
  • Service notifications (reminders, customer support)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Defines the payload for managing user consent actions.

string
enum
required

Specifies the consent action — opt-in or opt-out.

Allowed:
recipients
array of objects
required
length between 1 and 1000

Lists the recipients whose consent will be managed.

recipients*

Represents a single recipient’s consent or blocklist details.

string
required

Phone number of the recipient including country code (6–15 digits).

string
enum
required

Source from which the consent or blocklist request originated.

string
length ≤ 500

User agent string from the source device or application.

string

IP address from where the request originated.

Headers
string
required

Indicates the request body format. Must be application/json.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json