Tags Endpoints
Tags Endpoints
ImportantDon’t forget to include tokenAPI and cryptKey in your request.
Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={YOUR-TOKEN}
&cryptKey={YOUR-CRYPT-KEY}
List Document Tags
GET
/tags/{UUID-DOCUMENTO}
GET
/tags/{UUID-DOCUMENTO}
This method lists all TAGs assigned to a specific document.
The result returns up to 500 entries per page.
Use thepg
parameter in the URL to paginate the results. Example: https://secure.d4sign.com.br/api/v1/users/list?tokenAPI={YOUR-TOKEN}
&cryptKey={YOUR-CRYPT-KEY}
&pg=2The first block of the response shows the total number of pages available.
{
"Content-Type": "application/json"
}
{
"uuid_arquivo": "uuid-of-the-document",
"TAGs": "test1, test2, test4"
}
Add Tags to Document
POST
/tags/{UUID-DOCUMENTO}
/add
POST
/tags/{UUID-DOCUMENTO}
/addThis method adds a TAG to a document.
{
"Content-Type": "application/json"
}
{
"tag":"my tag"
}
{
"message": "TAGs added successfully",
"TAGs": "my tag"
}
Parameter | Description |
---|---|
tag (required) | The tag to be added. |
Remove Tags from Document
POST
/tags/{UUID-DOCUMENTO}
/remove
POST
/tags/{UUID-DOCUMENTO}
/removeThis method removes a TAG from a document.
{
"Content-Type": "application/json"
}
{
"tag":"my tag"
}
{
"message": "TAGs removed successfully",
"TAGs": "my tag"
}
Parameter | Description |
---|---|
tag (required) | The tag to be removed. |
Remove ALL Tags from Document
POST
/tags/{UUID-DOCUMENTO}
/erase
POST
/tags/{UUID-DOCUMENTO}
/eraseThis method removes ALL tags from a document.
{
"Content-Type": "application/json"
}
{
"message": "All TAGs removed successfully"
}
Add URGENT Tag to Document
POST
/tags/{UUID-DOCUMENTO}
/addurgent
POST
/tags/{UUID-DOCUMENTO}
/addurgentThis method adds the URGENT tag to your document.
{
"Content-Type": "application/json"
}
{
"message": "TAGs Urgent added successfully",
"TAGS": "Urgent"
}
To perform this request, you must either be the owner of the safe or have Administrator or Standard permission if the safe | vault is shared.
Remove URGENT Tag from Document
POST
/tags/{UUID-DOCUMENT}
/removeurgent
POST
/tags/{UUID-DOCUMENT}
/removeurgentThis method removes the URGENT tag from your document.
{
"Content-Type": "application/json"
}
{
"message": "Urgent TAG removed successfully",
"TAGs": "TAG"
}
To perform this request, you must either be the owner of the safe or have Administrator or Standard permission if the safe is shared.
Updated about 2 months ago