Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Consent Management

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)
post/v2/consent/manage

Headers

Content-Typestring required
Example:application/json

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

Request body

type'optin' | 'optout' required

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

Example request

{
  "type": "optin",
  "recipients": [
    {
      "recipient": "919876543210",
      "source": "WEB",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "ip": "192.168.7.26"
    }
  ]
}

Response

Indicates that user consent was updated successfully.

status'success' | 'error' required

Indicates success or failure of the request.

messagestring required

Human-readable message about the response.

Example response

{
  "status": "success",
  "message": "Opt-in successfully added.",
  "data": {
    "processed_count": 1,
    "failed_recipients": [
      {
        "recipient": "919876543210",
        "error": "Invalid phone number format"
      }
    ]
  }
}