Manage Recipient List Members

Add and remove recipients from a recipient list.

Note Use the Rename Recipient List API to change the list name.

Endpoint

POST /v1/recipients/lists/{namedRecipientsListId}/members

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

namedRecipientsListId REQUIRED

string (UUID)

Unique ID for the recipient list in RocketCOMS.

Request Body

recipientsToAdd

array of strings

List of recipient IDs to add to the list.

recipientsToRemove

array of strings

List of recipient IDs to remove from the list.

Returns

If successful, returns 200 Named recipients list updated successfully.

SAMPLE REQUEST

				
					{
  "recipientsToAdd": [
    "c0867abf-c939-4e42-abed-1ff2ebd6d5cf",
    "36544a86-748d-41ef-85c3-a3761412e23b"
  ],
  "recipientsToRemove": [
    "eb2d2c10-264f-4f1a-9fb4-d86041a53114"
  ]
}

SAMPLE RESPONSE

				
					{
  200  Named recipients list updated successfully
}