Rename a Recipient List

Change the name of a recipient list.

Note Use the Manage Recipient List Members API to add and remove members from a recipient list.

Endpoint

PATCH /v1/recipients/lists/{namedRecipientsListId}

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

name

string

Name of 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",
}

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
}