Fair API Pricing

No Surprise Fees

Secure Your Document Distribution and Management with a Signority API Plan

Update Invitation List

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

Description
Update the invitees of the document

 

Format
JSON <multipart/related>

 

URL Parameters
None (Replace docID with the document ID)

 

Data Parameters

Field Mandatory Type Description
sequence No Integer Signing order
recipientName Yes String Name of the recipient
recipientEmail Yes String Email of the recipient
actionType Yes Integer INVITATION_TYPE_SIGNER = 15;

INVITATION_TYPE_VIEWER = 16;
INVITATION_TYPE_REVIEWER = 17;
INVITATION_TYPE_SIGNING_HOST = 18;
INVITATION_TYPE_OPEN_SIGNER = 21;

Response
Response returns a response containing the list of invitees on the updated document or an error response

 

Response Parameters

Field Mandatory Type Description
ReminderEmailCount Yes Integer The number of reminder emails sent out so far
actionType Yes Integer INVITATION_TYPE_SIGNER = 15
INVITATION_TYPE_VIEWER = 16
INVITATION_TYPE_REVIEWER = 17
INVITATION_TYPE_SIGNING_HOST = 18
INVITATION_TYPE_OPEN_SIGNER = 21
authentications Yes JSON Authentications for the invitees
canSignTags Yes Boolean Invitee signing permissions
id Yes Integer The invitee’s id
lastReminderSent No Boolean True of the last reminder was sent to the invitee
recipientName Yes String The recipient’s name
recipientEmail Yes String The recipient’s email
sequence No Integer The order of which the invitee can access the document
status Yes Integer RECIPIENT_STATUS_NOT_SENT = 60
RECIPIENT_STATUS_WAIT_TO_OPEN = 61
RECIPIENT_STATUS_REACH_DEADLINE = 62
RECIPIENT_STATUS_WORK_IN_PROGRESS = 63
RECIPIENT_STATUS_VIEWED = 64
RECIPIENT_STATUS_REJECTED = 65
RECIPIENT_STATUS_FINALIZED = 67
RECIPIENT_STATUS_CANCELLED = 68
witnesses No JSONArray The information of witnesses to the signing

EXAMPLE REQUEST / RESPONSE (Python)
Request:
data =
{
    "invitations": [
        {
            "sequence": 1,
            "recipientName": "API TEST USER01",
            "recipientEmail": "user01@mail.com",
            "actionType": 15
        },
        {
            "sequence": 2,
            "recipientName": "API TEST USER02",
            "recipientEmail": "user02@mail.com",
            "actionType": 15
        }
    ]
}
requests.put('https://sign.signority.com/api/v1/documents/{doc_id}/invitations/', data, auth=(apiKey, ''))
Response:
{
    'invitations': [
        {
            'EnableIndicatorManuallyFilledAddress': True,
            'GUID': '3f51be7c-278b-40d9-a4ea-003bf6bdb161',
            'ReminderEmailCount': 0,
            'actionType': 15,
            'authentications': [],
            'canSignTags': True,
            'hostedSignerCanSignTags': True,
            'hostedSigners': [],
            'id': 33536,
            'invitationEmailBounced': False,
            'isBulkSigner': False,
            'lastReminderSent': False,
            'recipientEmail': 'user01@mail.com',
            'recipientName': 'API TEST USER01',
            'sequence': 1,
            'status': 60,
            'witnesses': []
        },
        {
            'EnableIndicatorManuallyFilledAddress': True,
            'GUID': '764c9e38-0e15-4e62-907e-d93d206dfece',
            'ReminderEmailCount': 0,
            'actionType': 15,
            'authentications': [],
            'canSignTags': True,
            'hostedSignerCanSignTags': True,
            'hostedSigners': [],
            'id': 33537,
            'invitationEmailBounced': False,
            'isBulkSigner': False,
            'lastReminderSent': False,
            'recipientEmail': 'user02@mail.com',
            'recipientName': 'API TEST USER02',
            'sequence': 2,
            'status': 60,
            'witnesses': []
        }
    ],
    'success': True
}