Fair API Pricing
No Surprise Fees
Secure Your Document Distribution and Management with a Signority API Plan
Home
Getting Started
API Reference
Use Cases
Frequently Asked Questions
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 | TAG_TYPE_SIGNATURE = 250; (signature tag)
TAG_TYPE_INITIAL = 251; (initial tag) TAG_TYPE_TEXT = 252; (text tag) TAG_TYPE_CHECKBOX = 253; (checkbox) TAG_TYPE_RADIO = 254; (radio buttons) TAG_TYPE_DATE = 255; (date tag) TAG_TYPE_ATTACHMENT = 256; (attachment tag) TAG_TYPE_DROPDOWN = 257; (dropdown tag) TAG_TYPE_NOTE = 258; (note tag) TAG_TYPE_MASKED_TEXT = 266; (masked text) TAG_TYPE_PREFILLABLE_TEXT = 267; (prefillable text) TAG_TYPE_PREFILLABLE_NUMBER = 268; (prefillable number) TAG_TYPE_NUMBER = 269; (number tag) |
|
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 | See table above | |
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 } ] }