Update Template Configuration

Update an existing template configuration, supporting modification of the template name, type, content, destination countries, and signature information. After updating, the template status will revert to "Pending Review".

Request URL

PUT https://smsapi.engagelab.com/v1/template-configs/:templateId

Call Authentication

Please refer to Call Authentication to learn how to authenticate API requests.

Request Example

Request Header

              
              PUT /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

              
              {
  "template_name": "Order Notification Template",
  "template_type": "utility",
  "template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

            

Request Parameters

Path Parameters

Request Body Parameters

Response Parameters

Success Response

The HTTP status code is 200, and the response body contains the following fields:

Success Example

              
              {
  "code": 0,
  "message": "success"
}

            

Error Response

The HTTP status code is 4xx/5xx, and the response body contains the following fields:

Error Example

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

Error Codes

Common error messages:

• invalid templateId: Template ID format error
• template config not exist: Template configuration does not exist
• can not update pending status template: Template in pending review status cannot be updated
• there are pending or running plans using current template, can not update: There are pending or running plans using this template, cannot be updated
• sign config not exist: Signature configuration does not exist
• sign status is not approved, can not use: Signature status is not approved, cannot be used

Notes

1. Templates in "Pending Review" status cannot be updated.
2. If there are pending or running message plans using this template, it cannot be updated.
3. After updating, the template status will revert to "Pending Review" (status=1).
4. If adding a signature, the signature must be in an approved status.
5. Template content cannot contain forbidden characters: 【, 】, 、, 测试, test, [, ]
6. Both template and signature IDs are string-type numbers.

Appendix

Template Configuration Status (status)

Template Type (template_type)

Signature Position (sign_position)