Create a Recipient List

Create a list of recipients that you can use for a campaign batch. The recipients must already exist in RocketCOMS in order to add them to the list.

Note You can also automatically create a recipient list when creating a recipient batch.

Endpoint

POST /v1/recipients/lists

Authorization Header

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

Request Body

name

string

Name of the recipient list.

recipientIds

array of string

List of recipient IDs to add to the recipient list.

Returns

Returns the Recipient List object. This object contains the list details including the number of recipients.

SAMPLE REQUEST

				
					{
  "name": "Recipient List",
  "recipientIds": [
    "3027547b-0dc4-40fd-9d31-2a2878b1b6ef",
    "d501c95c-b52c-40b2-981f-8e82c9dd3eb4",
    "6c4e977f-189d-4e9a-b5d6-bf7a235e7df7"
  ]
}

SAMPLE RESPONSE

				
					{
  "id": "23e281a7-b9bc-4a11-8657-3ca0600e2451",
  "name": "Recipient List",
  "createdAt": "2023-10-21T23:30:08.942Z",
  "updatedAt": "2023-10-31T23:30:08.942Z",
  "recipientsAmount": 200
}