Delete template tags
delete/v1/template/deleteTagsEach template has its own set of tags that can be used for searching the templates. This API allows users to delete tags from the template that are no longer supported. When the template is created on behalf of a particular sender email, then the delete tag operation can be performed on the same account by specifying the email in the onBehalfOf
.
Code snippet
curl -X DELETE "https://api.boldsign.com/v1/template/deleteTags" -H 'X-API-KEY: {your API key}' -H "Content-Type: application/json" -d "{\"templateId\": \"{templateId}\", \"documentLabels\": [\"test\", \"api\"], \"templateLabels\": [\"test\", \"api\"]}"
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}"); var templateClient = new TemplateClient(apiClient); var deletetag = new TemplateTag() { TemplateId = "{documentId}", DocumentLabels = new List<string>() { "test", "api" }, TemplateLabels = new List<string>() { "test", "api" }, }; await templateApi.DeleteTagAsync(deletetag).ConfigureAwait(false);
import boldsign configuration = boldsign.Configuration( api_key = "YOUR_API_KEY" ) with boldsign.ApiClient(configuration) as api_client: template_api = boldsign.TemplateApi(api_client) templateTag = boldsign.TemplateTag( templateId="YOUR_TEMPLATE_ID", documentLabels=[ "test", "api" ], templateLabels=[ "test", "api" ] ) delete_tag_response = template_api.delete_tag(template_tag=templateTag)
const axios = require('axios'); await axios.delete( 'https://api.boldsign.com/v1/template/deleteTags', { headers: { 'X-API-KEY': '{Your API key}', 'Content-Type': 'application/json' }, data: { templateId: '{templateId}', documentLabels: [ 'test', 'api' ], templateLabels: [ 'test', 'api' ] }, } );
<?php require_once "vendor/autoload.php"; use GuzzleHttp\Client; use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-API-KEY' => '{your API key}', 'Content-Type' => 'application/json' ]; $body = '{ "templateId": "{templateId}", "documentLabels": [ "test", "api" ], "templateLabels": [ "test", "api" ] }'; $request = new Request('DELETE', 'https://api.boldsign.com/v1/template/deleteTags', $headers, $body); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
Request body
templateIdstringRequired | ID of the requested template. |
documentTagsarrayRequired | A collection of tags that will be removed from the document that derived from this template. It can only contain a maximum of 50 tags. Each tag cannot exceed 255 characters and cannot contain white space. |
templateTagsarrayRequired | A collection of tags that will be removed from the template. It can only contain a maximum of 50 tags. Each tag cannot exceed 255 characters and cannot contain white space. |
onBehalfOfstringRequired | Mail ID of the user to view or edit the template on behalf of them. |
Example response
200 Success