Update a Message Template

Update a message template name or the message content. You can also activate or archive a template by changing the status.

Endpoint

PATCH /v1/message-templates/{messageTemplateId}

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

messageTemplateId REQUIRED

string (UUID)

Unique ID for the message template in RocketCOMS.

Request Body

name

string

Name of the message template.

message

string

Message content.

status

string enum, values: ACTIVE, ARCHIVED

Status of the message template. Possible values are:

ACTIVE The message template is available for use.
ARCHIVED The message template is archived and is not available for use.

Returns

Returns the Message Template object. This object contains the template details and status.

SAMPLE REQUEST

				
					{
  "status": "ACTIVE"
}

SAMPLE RESPONSE

				
					{
  "id": "a9e1e4ce-0d9e-4298-8059-178e17d31c11",
  "name": "Spring Campaign",
  "message": "Our spring sale starts tomorrow!",
  "status": "ACTIVE",
  "createdAt": "2023-11-02T16:58:25.808Z",
  "updatedAt": "2023-11-03T16:58:25.808Z"
}