Delete email message template API

This API is used to delete a message template that was created using the API. The email template id should be provided in the request.

📘

Know your endpoint

Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request HeaderDescription
content-typeapplication/json
authorizationAccess token or API Secret Key in Bearer format

Example: Bearer $(key)

Body Parameters

The following table describes the elements in the request body:

ParameterTypeMandatoryDescription
channelStringMandatorySpecifies the channel. The options are:
* email

Request Example



https://<yourdomain>/campaignapi/resources/v3/message-templates/16654964070008?channel=email

Response Example

{   
    "id": "16715338090115",
    "name": "sample_emailtemplate",
    "message": "Email Template deleted successfully."
}

Response Parameters

This API will return the following response parameters:

ParameterDescription
idReturns the message template id
nameReturns the name of the email template that is updated.
messageReturns the confirmation message.

Failure Response Codes

The API will return the code within the response as per the following table in case of failure scenarios.

HTTP Status CodeCode within API ResponseDescription
400400I/O error on post request. Cannot retry due to server authentication, in streaming mode.
400400The requested asset is not present.
401430Authorization failed. This resource is not allowed to access using this TOKEN or KEY
401498Invalid token or Access token expired
404404Not found
405405Method not supported
500500Internal server error
500500Required String parameter 'channel' is not present"
5001002Mandatory field missing
Language