Whatsapp opt-out/opt-in API
The WhatsApp opt-in API allows you to inform Clickpost systems if WhatsApp communication shall be enabled/disabled for a particular shipment
Overview
The Whatsapp opt-in API allows you to inform Clickpost systems if Whatsapp communication shall be enabled/disabled for a particular shipment.
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This is a standard API which supports all shipments created and transported within
- India
- North America
- Europe
- Middle East
- South East Asia
Query Parameters
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
key | string | Mandatory | Unique license key provided by Clickpost for the enterprise | 00000000-0000-0000-0000-000000000000 |
Request Body
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
awb | string | Mandatory | The airway bill number of the shipment for which Whatsapp | "4152912745934" | |
whatsapp_disable | boolean | Mandatory | Whether Whatsapp communication needs to be disabled for a particular shipment | true |
Response
meta [meta parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | The message from clickpost. In case of success it will be "SUCCESS". In case that there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable" | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |
Updated 7 months ago
Did this page help you?
