Fair API Pricing

No Surprise Fees

Secure Your Document Distribution and Management with a Signority API Plan

Create Document Tags

PUT: /v1/documents/{docID}/tags/

Description
Update the tags on a specific document

 

Format
JSON <multipart/related>

 

URL Parameters
None (Replace docID with the document’s ID)

 

Data Parameters

Field Mandatory Type Description
id Integer ID of the tag
pageId Integer Page that the tag is on
name String Name of the tag
groupName String Name of group (If applicable)
isMandatory Boolean Whether the field must be filled out
height Integer Number of pixels in height
invitationId Integer ID of the user it’s assigned to
left Integer Number of pixels from the left of the file
top Integer Number of pixels from the top of the file
type Integer Contact us for more information about it’s usage
width Integer Number of pixels in width
text String Text shown in text tag
image String Image source for image tag
style JSONString Contact us for usage

Response
Response returns a response containing the information of the tags on the updated document or an error response

 

Response Parameters

Field Mandatory Type Description
success Boolean True if the request was successful, False otherwise
id Integer ID of the tag
pageId Integer Page that the tag is on
name String Name of the tag
groupName String Name of group (If applicable)
isMandatory Boolean Whether the field must be filled out
height Integer Number of pixels in height
invitationId Integer ID of the user it’s assigned to
left Integer Number of pixels from the left of the file
top Integer Number of pixels from the top of the file
type Integer Contact us for more information about it’s usage
width Integer Number of pixels in width
text String Text shown in text tag
image String Image source for image tag
style JSONString Contact us for usage

EXAMPLE REQUEST / RESPONSE (Python)
Request:
data =
{
        "tags": [
            {
                "pageIndex": 0,
                "invitationIndex": 0,
                "name": "U01",
                "isMandatory": True,
                "height": 35,
                "width": 107,
                "left": 200,
                "top": 200,
                "type": 250
            },
            {
                "pageIndex": 0,
                "invitationIndex": 0,
                "name": "U02",
                "isMandatory": True,
                "height": 35,
                "width": 107,
                "left": 200,
                "top": 200,
                "type": 250
            }
        ]
}
requests.put('https://sign.signority.com/api/v1/documents/{doc_id}/tags/', data, auth=(apiKey, ''))
Response:
{
    'success': True,
    "tags": [
            {
                "pageIndex": 0,
                "invitationIndex": 0,
                "name": "U01",
                "isMandatory": True,
                "height": 35,
                "width": 107,
                "left": 200,
                "top": 200,
                "type": 250
            },
            {
                "pageIndex": 0,
                "invitationIndex": 0,
                "name": "U02",
                "isMandatory": True,
                "height": 35,
                "width": 107,
                "left": 200,
                "top": 200,
                "type": 250
            }
        ]
}