Delete template tags

delete/v1/template/deleteTags

Each 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"]
    )
    
    template_api.delete_tag(templateTag)
<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$template_api = new BoldSign\Api\TemplateApi($config);
$templateTag = new BoldSign\Model\TemplateTag();
$templateTag->setTemplateId('YOUR_TEMPLATE_ID'); 
$templateTag->setDocumentLabels(['test', 'api']);
$templateTag->setTemplateLabels(['test', 'api']);

$template_api->deleteTag($templateTag);
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
TemplateApi templateApi = new TemplateApi(client);
TemplateTag templateTag = new TemplateTag();
templateTag.setTemplateId("YOUR_TEMPLATE_ID");
templateTag.setDocumentLabels(Arrays.asList("test", "api"));
templateTag.setTemplateLabels(Arrays.asList("test", "api"));

templateApi.deleteTag(templateTag);
import { TemplateApi,TemplateTag  } from "@boldsign/node-sdk";

const templateApi = new TemplateApi();
templateApi.setApiKey("YOUR_API_KEY");

const deleteTag = new TemplateTag();
deleteTag.templateId = "YOUR_TEMPLATE_ID";
deleteTag.documentLabels = ["test", "api"];
deleteTag.templateLabels = ["test", "api"];

templateApi.deleteTag(deleteTag);

Request body

templateIdstringRequiredID of the requested template.
documentLabelsarrayRequiredA 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.
templateLabelsarrayRequiredA 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.
onBehalfOfstringMail ID of the user to view or edit the template on behalf of them.

Example response

200 Success