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.

Run in Postman API Reference

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

  1. India
  2. North America
  3. Europe
  4. Middle East
  5. South East Asia

Query Parameters

Field NameData TypeFieldDescriptionMax LengthExample
keystringMandatoryUnique license key provided by Clickpost for the enterprise00000000-0000-0000-0000-000000000000

Request Body

Field NameData TypeFieldDescriptionMax LengthExample
awbstringMandatoryThe airway bill number of the shipment for which Whatsapp"4152912745934"
whatsapp_disable booleanMandatoryWhether Whatsapp communication needs to be disabled for a particular shipmenttrue

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringThe 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"
statusHTTP CodeThe HTTP response status code of the API request200

Did this page help you?