Delete Signature Configuration

Delete the specified signature configuration. If the signature is currently being used by a message plan (in pending or running status), it cannot be deleted.

Request URL

DELETE 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

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

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

This code block in the floating window

Request Body

None

Request Parameters

Path Parameters

Parameter	Type	Option	Description
signId	String	Required	Signature ID

Response Parameters

Success Response

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

Field	Type	Description
code	Integer	Status code, 0 indicates success
message	String	Status description

Success Example

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

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

This code block in the floating window

Error Response

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

Field	Type	Description
code	Integer	Error code
message	String	Error details

Error Example

{ "code": 400, "message": "there are pending or running plans using current sign, can not update" }

              
              {
  "code": 400,
  "message": "there are pending or running plans using current sign, can not update"
}

This code block in the floating window

Error Codes

Error Code	HTTP Code	Description
400	400	Parameter error or business logic error
500	500	Internal server error

Common error messages:

invalid signId: Signature ID format error
sign config not exist: Signature configuration does not exist
there are pending or running plans using current sign, can not update: There are pending or running plans using this signature, cannot be deleted

Notes

If there are pending or running message plans using this signature, it cannot be deleted.
The signature ID is a string-type number.