Update Signature Configuration

Update an existing signature configuration, supporting modification of the signature name. After updating, the signature status will revert to "Pending Review".

Request URL

PUT https://smsapi.engagelab.com/v1/sign-configs/:signId

Call Authentication

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

Request Example

Request Header

              
              PUT /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

              
              {
  "sign_name": "Company Name"
}

            

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 sign"
}

            

Error Codes

Common error messages:

• invalid signId: Signature ID format error
• sign config not exist: Signature configuration does not exist
• sign_name already exist: Signature name already exists
• can not update pending status sign: Signature in pending review status cannot be updated
• there are pending or running plans using current sign, can not update: There are pending or running plans using this signature, cannot be updated

Notes

1. Signatures in "Pending Review" status cannot be updated.
2. If there are pending or running message plans using this signature, it cannot be updated.
3. After updating, the signature status will revert to "Pending Review" (status=1).
4. Signature names cannot contain forbidden characters: 【, 】, [, ]
5. The signature ID is a string-type number.

Appendix

Signature Configuration Status (status)