RCS Templates

Update an RCS template

put/rcs/template/{template_id}

Request

Base URL
https://rcs-api.in.kaleyra.io/v1/XXXXX6913850XXXX
URL
https://rcs-api.in.kaleyra.io/v1/XXXXX6913850XXXX/rcs/template/{template_id}
Auth
none declared. Required headers: Content-Type, api-key

Path parameters

template_idstring required

Template ID.

Headers

Content-Type'application/json' required

Indicates the format of the content the API will process. The documented value is application/json.

api-keystring required

API key generated from the Kaleyra account.

Request body

template_idstring required

Unique template ID. Required but cannot be modified.

agent_numberstring required

RCS agent number.

template_type'1' | '3' | '4' | '5' required

Template type. 1 is Text, 3 is File, 4 is Rich Card Standalone, and 5 is Rich Card Carousel.

template_namestring required

Unique template name. Maximum 20 characters including alphanumeric characters and underscore. Space is not allowed.

textstring

Text message to send to end users. Maximum 2000 characters. Conditional when template_type is 1.

status'DRAFT' | 'CREATED' | 'SUBMITTEDFORAPPROVAL' | 'ACTIVE' | 'FAILED' | 'DELETED' required

Template status. DRAFT can be edited. CREATED can be edited until ACTIVE. SUBMITTEDFORAPPROVAL indicates submission to the carrier. ACTIVE templates can be used for messaging and cannot be edited. FAILED and DELETED are documented workflow states.

template_numberstring required

Template reference number. Restricted field and cannot be modified.

Example request

{
  "template_id": "3a7370e5-ebcd-4fc3-95cc-6dXXXXXXXX8e",
  "agent_number": "116XX2",
  "template_name": "SHORT_TEXT",
  "text": "This is a text updated template message",
  "template_number": "MN6XXXXXXXXX"
}

Response

RCS Template updated successfully.

codestring

messagestring

errorobject

Example response

{
  "code": "RCS1102",
  "message": "RCS Template updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.