Retrieve Opt-out Messages

Retrieve all opt-out messages for a campaign.

Endpoint

GET /v1/campaigns/{id}/optouts

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id REQUIRED

string (UUID)

Unique ID assigned to the campaign in RocketCOMS.

Request Body

None

Returns

Returns an array of opt-out responses. The following fields are returned for each response.

optoutAt

string

Date and time the opt-out message was received.

optoutText

string

Content of the opt-out message.

destination

string

Destination phone number for the campaign recipient.

SAMPLE RESPONSE

				
					[
  {
    "optoutAt": "2022-04-23T22:52:52.590Z",
    "optoutText": "No",
    "destination": "5555551234"
  }
]