Opt Outs HTTP API

This API is used to retrieve and update opt out information for addresses.

API Methods

GET /optouts/(str: address_type)/(str: address)

Retrieve the opt out for an address.

Request

GET /optouts/msisdn/%2B273121100
Host: example.com
Accept: application/json

Response

HTTP/1.1 200 OK
Vary: accept
Content-type: application/json

{
  "id": "2468"",
  "address_type": "msisdn",
  "address": "+273121100"
}

Status Codes:

• 200 OK – no error
• 404 Not Found – there’s no opt out for this contact

PUT /optouts/(str: address_type)/(str: address)

Store a record of an opt out for an address.

Request

PUT /optouts/facebook/fb-app
Host: example.com
Accept: application/json

Response

HTTP/1.1 200 OK
Vary: accept
Content-type: application/json

{
  "id": "1234",
  "address": "fb-app",
  "address_type": "facebook"
}

Status Codes:

• 200 OK – opt out created

DELETE /optouts/(str: address_type)/(str: address)

Remove an opt out for an address.

Request

DELETE /optouts/twitter/%40twitter_handle
Host: example.com
Accept: application/json

Response

HTTP/1.1 200 OK
Vary: accept
Content-type: application/json

{
  "id": "5678",
  "address": "@twitter_handle",
  "address_type": "twitter"
}

Status Codes:

• 200 OK – opt out deleted