Delete Template API
Introduction
Welcome to the Delete Template API documentation. This comprehensive guide will walk you through the seamless process of utilizing our powerful API endpoint designed to remove templates from our system effortlessly. By integrating this feature into your application, you can efficiently manage your template repository, ensuring a streamlined and organized workflow. With just a simple input of the template ID, you can swiftly delete templates, enhancing the flexibility and responsiveness of your platform. Join us as we delve into the details of how to leverage the Delete Template API to effectively maintain your template ecosystem and keep your system clutter-free. Let's embark on this journey to harness the full potential of template management within your application.
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call.
API Details
The details of the API can be found here.
Sample cURL
curl --location --request DELETE 'https://api-preproduction.signzy.app/api/v3/template/delete/:templateId' \
--header 'Authorization: *****************************' \
--header 'Content-Type: application/json' \
--data '{
}'Sample Response
{
"status":"success/failure",
"statusDesp":"description",
}Output Parameters
Key | Description | Type |
|---|---|---|
status | Indicates the status of the operation | String |
statusDesp | Description of the status | String |
Sample Errors
{
"name": "error",
"message": "Invalid URL extension",
"reason": "VALIDATION_ERROR",
"type": "Bad Request",
"statusCode": 400
}Error Parameters
Parameter | Type | Description |
|---|---|---|
name | String | In case of errors, it will have the value "error". It represents an error. |
message | String | Message for the error |
reason | String | Reasons for the error |
type | String | Type of error |
statusCode | String | Status code of the error |
Error Codes
Error Code | Error Message | Explanation |
|---|---|---|
400 | Bad Request | Input parameter has a missing required parameter or invalid inputs |
401 | Authorization Failed | Authorization token is invalid |
500 | Internal Server Error | Internal error at Signzy, Please write to us at [email protected] |