Document Group

Document Group is an object with one ID that contains several documents. It helps automate signature requests for multiple documents from multiple signers.

To create a document group, all documents:

  • Must be owned by the person creating the document group.
  • Cannot be templates.
  • Cannot already be a part of another document group (delete document group first to add them).
  • At least one of the documents must have fields.

Before creating a Document Group, you should first have all the document IDs ready. Either save them from responses from the POST /document requests, or copy the IDs from the response from the GET /user/documents request.

Related article: Document Group

The document group object

Attributes
  • id string
    Unique identifier for the object.
  • group_name string
    The name of the document group.
  • invite_id string
    The identifier of the invite to sign the documents in the group; null if there is no group invite for the group yet.
  • documents array[object]
    Attributes of each document in the group assigned to roles
  • roles array[string]
    Role names for signer roles, e.g. Signer 1, Signer 2.
  • document_name string
    The name of the document assigned to the role
  • id string
    The document identifier.
More attributes
  • thumbnail object
  • origin_document_id string
  • has_unassigned_field boolean
  • has_credit_card_number boolean

Example in the response here: https://docs.signnow.com/sn/ref/document-group/getdocumentgroupdocumentgroupid

The template object
                { 
              
                  "id": "bc9bdf90883566a9eb2a01c43fede3755f71a4f2", 
              
                  "group_name": "new doc group", 
              
                  "invite_id": "474ea9deca354269bd9a66ef5e024f5fb0f145a4", 
              
                  "documents": [ 
              
                    { 
              
                      "roles": [ 
              
                        "Signer 1" 
              
                      ], 
              
                      "document_name": "pdf-test", 
              
                      "id": "19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad", 
              
                      "thumbnail": { 
              
                        "small": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=small", 
              
                        "medium": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=medium", 
              
                        "large": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=large" 
              
                      }, 
              
                      "origin_document_id": "73af77a925534b171fed6ea333f5e785851d69f4",   
              
                      "has_unassigned_field": false, 
              
                      "has_credit_card_number": false 
              
                    }, 
              
                    { 
              
                      "roles": [ 
              
                        "Employer Representative" 
              
                      ], 
              
                      "document_name": "marmat 1", 
              
                      "id": "6f64ca38e2a0ef3cd775c13d34efc86abddbceba", 
              
                      "thumbnail": { 
              
                        "small": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=small", 
              
                        "medium": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=medium", 
              
                        "large": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=large" 
              
                      }, 
              
                      "origin_document_id": "7627fe37cde590dbe47907355ef05efa4d29df8d", 
              
                      "has_unassigned_field": false, 
              
                      "has_credit_card_number": false 
              
                    } 
              
                  ], 
              
                  "originator_organization_settings": [] 
              
                }
              

Create document group

Creates a document group from a list of document IDs.

To create a document group, all documents:

  • Must be owned by the person creating the document group.
  • Cannot be templates.
  • Cannot already be a part of another document group (delete document group first to add them).
  • At least one of the documents must have fields.
Parameters
  • document_ids required
    IDs of documents to be included in a group
  • group_name required
    Name of a document group
Returns

Returns ID of a new document group.

POST /documentgroup
                
                  curl 
                  -X POST
                   \
                
              
                
                    https://api-eval.signnow.com/documentgroup
                   \
                
              
                
                    -H
                   'Authorization:
                   Bearer {{access_token}}'
                
              
                
                    -H
                   'Content-Type: 
                   application/json'
                   \
                
              
                
                    -d
                   '{
                
              
                
                     "document_ids": 
                   [ 
                
              
                
                      "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b",  
                
              
                
                      "dd63da6fbe213863626a61d36b0c13ce61e4a2be"
                
              
                
                     ],
                
              
                
                    "group_name":
                    "Document Group 1"
                
              
                
                    }'
                
              
Response
                  { 
                
                    "id": "68a31715f60b8a2e0df3ef1b4bc1a22cece3876c4a9a029dc845e4fa098517a0" 
                
                  }
                

Get document group

Returns document and roles information for documents in a document group. The invite_id property is null if there is no group invite for the group yet.

Parameters
  • document_group_id required
    IDs of documents to be included in a group
Returns

Returns document and roles information for documents in a document group.

GET /documentgroup/{document_group_id}
                  
                    curl 
                    -X GET
                     \
                  
                
                  
                      https://api-eval.signnow.com/documentgroup/{{document_group_id}}
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                  { 
                
                    "id": "bc9bdf90883566a9eb2a01c43fede3755f71a4f2", 
                
                    "group_name": "new doc group", 
                
                    "invite_id": "474ea9deca354269bd9a66ef5e024f5fb0f145a4", 
                
                    "documents": [ 
                
                      { 
                
                        "roles": [ 
                
                          "Signer 1" 
                
                        ], 
                
                        "document_name": "pdf-test", 
                
                        "id": "19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad", 
                
                        "thumbnail": { 
                
                          "small": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=small", 
                
                          "medium": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=medium", 
                
                          "large": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=large" 
                
                        }, 
                
                        "origin_document_id": "73af77a925534b171fed6ea333f5e785851d69f4",   
                
                        "has_unassigned_field": false, 
                
                        "has_credit_card_number": false 
                
                      }, 
                
                      { 
                
                        "roles": [ 
                
                          "Employer Representative" 
                
                        ], 
                
                        "document_name": "marmat 1", 
                
                        "id": "6f64ca38e2a0ef3cd775c13d34efc86abddbceba", 
                
                        "thumbnail": { 
                
                          "small": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=small", 
                
                          "medium": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=medium", 
                
                          "large": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=large" 
                
                        }, 
                
                        "origin_document_id": "7627fe37cde590dbe47907355ef05efa4d29df8d", 
                
                        "has_unassigned_field": false, 
                
                        "has_credit_card_number": false 
                
                      } 
                
                    ], 
                
                    "originator_organization_settings": [] 
                
                  }
                

Delete document group

Deletes a document group.Documents within the group are not deleted. Document groups cannot be deleted while they have a group invite.

Parameters
  • document_group_id required
    IDs of a document group to delete
Returns

Returns the status of the deletion.

DELETE /documentgroup/{document_group_id}
                  
                    curl 
                    -X DELETE
                     \
                  
                
                  
                      https://api-eval.signnow.com/documentgroup/{{document_group_id}}
                     \
                  
                
                  
                      --header
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                  { 
                
                    "status": "success" 
                
                  }
                

Get document groups

Returns back all document groups the user owns.The call is paginated by last_updated, so offset and limit query parameters are required.

Parameters
  • limit required
    Limit must be greater than 0 but less than or equal to 50.
  • offset required
    Offset must be 0 or greater.
Returns

Returns document and roles information for documents in document groups.

GET /user/documentgroup/{document_group_id}
                  
                    curl 
                    -X GET
                     \
                  
                
                  
                        'https://api-eval.signnow.com/user/documentgroups?offset=2&limit=5'
                     \
                  
                
                  
                        -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                   { 
                
                   "document_groups": [ 
                
                     { 
                
                       "last_updated": "1563886628", 
                
                       "group_id": "bc9bdf90883566a9eb2a01c43fede3755f71a4f2", 
                
                       "group_name": "new doc group", 
                
                       "invite_id": "474ea9deca354269bd9a66ef5e024f5fb0f145a4", 
                
                       "invite_status": "pending", 
                
                       "documents": [ 
                
                         { 
                
                           "id": "19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad", 
                
                           "name": "pdf-test", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Signer 1" 
                
                           ] 
                
                         }, 
                
                         { 
                
                           "id": "6f64ca38e2a0ef3cd775c13d34efc86abddbceba", 
                
                           "name": "marmat 1", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Employer Representative" 
                
                           ] 
                
                         } 
                
                       ] 
                
                     }, 
                
                     { 
                
                       "last_updated": "1549032635", 
                
                       "group_id": "304a4bbe9d0ad86ec9793cb43fc5e24731748d0e", 
                
                       "group_name": "doc_group", 
                
                       "invite_id": "3aacc04b1b5e494b9f2ebaaa10a24b5a791d9896", 
                
                       "invite_status": "pending", 
                
                       "documents": [ 
                
                         { 
                
                           "id": "f56f504c8d5a27ef0bc595bc20712be791009911", 
                
                           "name": "pdf-test", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Signer 1" 
                
                           ] 
                
                         }, 
                
                         { 
                
                           "id": "038588bdf8c65eb52cd7f17cc6c2748fbef38ef6", 
                
                           "name": "marmat 1", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Employer Representative" 
                
                           ] 
                
                         } 
                
                       ] 
                
                     }, 
                
                     { 
                
                       "last_updated": "1540294396", 
                
                       "group_id": "60c56c4fde68ac503856dff0866f3649c19e49fe", 
                
                       "group_name": "doc_group", 
                
                       "invite_id": "62feef84e08c4983aadaca721afa7319a3625584", 
                
                       "invite_status": "pending", 
                
                       "documents": [ 
                
                         { 
                
                           "id": "1505d4d6a2ea51b52420a043109aea9f5d080025", 
                
                           "name": "wcc_07_2018", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Signer 1", 
                
                             "signer 2" 
                
                           ] 
                
                         }, 
                
                         { 
                
                           "id": "c3c6a8eb7f8f632f20b115222035af256018a757", 
                
                           "name": "marmat 1", 
                
                           "thumbnail": 
                
                             { 
                
                               "small": "https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=small", 
                
                               "medium": "https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=medium", 
                
                               "large": "https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=large" 
                
                             }, 
                
                           "has_credit_card_number": false, 
                
                           "roles": [ 
                
                             "Signer 1", 
                
                             "signer 2" 
                
                           ] 
                
                         } 
                
                       ] 
                
                     } 
                
                   ], 
                
                   "document_group_total_count": 3, 
                
                   "originator_organization_settings": [ 
                
                     { 
                
                       "setting": "invite_completion_redirect_url", 
                
                       "value": "https://my_site.com" 
                
                     }, 
                
                     { 
                
                       "setting": "invite_decline_redirect_url", 
                
                       "value": "" 
                
                     }, 
                
                     { 
                
                       "setting": "required_preset_signature_name", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "require_email_subject", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "require_login_for_signing", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "logout_on_signing", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "front_end_session_length", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "add_signature_stamp_with_name", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "cfr_title_21_part_11", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "require_authentication_for_invites", 
                
                       "value": "0" 
                
                     }, 
                
                     { 
                
                       "setting": "document_guide", 
                
                       "value": "1" 
                
                     }, 
                
                     { 
                
                       "setting": "disable_email_notifications", 
                
                       "value": "0" 
                
                     } 
                
                   ] 
                
                  }
                

Invite to sign document group

Creates a multi-step invite for a document group. Each invite step consists of invite_email objects that set the email message or can disable emails all together for specific user. Invite steps also are made of the invite_action objects that need to be completed before the step is considered complete. Once all the invite_actions are completed, the next step’s invite emails are sent out. When all steps have been completed, completion emails are sent out.

Parameters
  • document_group_id required
    ID of the document group to be signed
More parameters
  • invite_steps required
    Invite steps for different signers
  • invite_emails required
    Signers’ emails
  • invite_actions required
    Actions which signers are allowed to do
Completion emails
  • email optional
    Signer’s email to receive the document copy after completion.
  • subject optional
    Email subject
  • message optional
    Email message
Returns

Returns document group ID.

POST /documentgroup/{document_group_id}/groupinvite
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                      https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
                  
                      -H
                     'Content-Type: 
                     application/json'
                     \
                  
                
                  
                      -d
                     '{
                  
                
                  
                       "invite_steps":
                     [ 
                  
                
                  
                        {
                  
                
                  
                         "order":1,  
                  
                
                  
                         "order"invite_emails": 
                     [ 
                  
                
                  
                          { 
                  
                
                  
                           "email":
                    "janedoe@signnow.com", 
                  
                
                  
                           "disabled":
                    0,
                  
                
                  
                           "subject":
                    "The subject step1", 
                  
                
                  
                           "message":
                    "The message for step1", 
                  
                
                  
                           "expiration_days":30,
                    "reminder":0 
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    "janedoe@signnow.com", 
                  
                
                  
                           "disabled":
                    0,
                  
                
                  
                           "subject":
                    "The subject step1", 
                  
                
                  
                           "message":
                    "The message for step1", 
                  
                
                  
                           "expiration_days":30,
                    "reminder":0 
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    "test@signnow.", 
                  
                
                  
                           "subject":
                    "The subject step1", 
                  
                
                  
                           "message":
                    "The message for step1", 
                  
                
                  
                           "expiration_days":,
                    30 
                  
                
                  
                           "reminder":
                    3
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    "bob@SignNow.com", 
                  
                
                  
                           "subject":
                    "@signnow subject step 1", 
                  
                
                  
                           "message":
                    "@signnow message step 1", 
                  
                
                  
                           "expiration_days":
                    30,
                  
                
                  
                           "reminder":
                    0
                  
                
                  
                          },
                  
                
                  
                         ]
                  
                
                  
                         "invite_actions": 
                    [
                  
                
                  
                          {
                  
                
                  
                           "email":
                    " janedoe@signnow.com",
                  
                
                  
                           "role_name":
                    "role6",
                  
                
                  
                           "action":
                    "sign",
                  
                
                  
                           "document_id":
                    "dd63da6fbe213863626a61d36b0c13ce61e4a2be",
                  
                
                  
                           "allow_reassign":
                    0,
                  
                
                  
                           "authentication":
                  
                
                  
                            {
                  
                
                  
                             "type":
                    "password",
                  
                
                  
                             "value": 
                    abc123" 
                  
                
                  
                            },
                  
                
                  
                           },
                  
                
                  
                           {
                  
                
                  
                            "email": 
                    " test@signnow.com",
                  
                
                  
                            "role_name":
                    "role2",
                  
                
                  
                            "action":
                    "sign",
                  
                
                  
                            "document_id":
                    "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b", 
                  
                
                  
                            "allow_reassign":
                    0 
                  
                
                  
                           }
                  
                
                  
                          ]
                  
                
                  
                         },
                  
                
                  
                         {
                  
                
                  
                          "order":
                    2,
                  
                
                  
                          "invite_emails":
                     [
                  
                
                  
                           {
                  
                
                  
                            "email":
                    "janedoe@signnow.com",
                  
                
                  
                            "disabled":
                    0,
                  
                
                  
                            "subject":
                    "The subject for step2",
                  
                
                  
                            "message":
                    "The message for step2"
                  
                
                  
                           },
                  
                
                  
                           {
                  
                
                  
                            "email":
                    " test@signnow.com", 
                  
                
                  
                            "subject":
                    "subject step 2", 
                  
                
                  
                            "message":
                    " message step 2" 
                  
                
                  
                           },
                  
                
                  
                          ]
                  
                
                  
                         "invite_actions": 
                    [
                  
                
                  
                         "invite_actions": 
                    [
                  
                
                  
                          {
                  
                
                  
                           "email":
                    janedoe@signnow.com",
                  
                
                  
                           "email":
                    janedoe@signnow.com",
                  
                
                  
                           "role_name":
                    "role4",
                  
                
                  
                           "document_id":
                    "dd63da6fbe213863626a61d36b0c13ce61e4a2be", 
                  
                
                  
                           "allow_reassign":
                    0
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    "test@signnow.com",
                  
                
                  
                           "role_name":
                    "role5",
                  
                
                  
                           "action":
                    "view", 
                  
                
                  
                           "document_id":
                    "dd63da6fbe213863626a61d36b0c13ce61e4a2be", 
                  
                
                  
                           "allow_reassign":
                    0
                  
                
                  
                          }
                  
                
                  
                         ]
                  
                
                  
                        },
                  
                
                  
                        {
                  
                
                  
                         "order":
                    3,
                  
                
                  
                         "invite_emails": 
                    [
                  
                
                  
                          {
                  
                
                  
                           "email":" 
                    janedoe@signnow.com",
                  
                
                  
                           "disabled":
                    0,
                  
                
                  
                           "subject":
                    "The subject for step3",
                  
                
                  
                           "message":
                    "The message for step3"
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    test@signnow.com",
                  
                
                  
                           "subject":
                    "subject step 3", 
                  
                
                  
                           "message":
                    "message step 3"
                  
                
                  
                          }
                  
                
                  
                         ],
                  
                
                  
                         "invite_actions": 
                    [
                  
                
                  
                          {
                  
                
                  
                           "email":
                    "janedoe@signnow.com",
                  
                
                  
                           "role_name":
                    "role1",
                  
                
                  
                           "action":
                    "sign",
                  
                
                  
                           "document_id":
                    "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b",
                  
                
                  
                           "allow_reassign":
                    0
                  
                
                  
                          },
                  
                
                  
                          {
                  
                
                  
                           "email":
                    " test@signnow.com", 
                  
                
                  
                           "role_name":
                    "role3",
                  
                
                  
                           "action":
                    "sign", 
                  
                
                  
                           "document_id":
                    "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b", 
                  
                
                  
                            "allow_reassign":
                    0
                  
                
                  
                           }
                  
                
                  
                          ]
                  
                
                  
                         }
                  
                
                  
                        ],
                  
                
                  
                       "completion_emails":
                    [
                  
                
                  
                        "email":
                    " janedoe@signnow.com", 
                  
                
                  
                        "disabled":
                    0,
                  
                
                  
                        "subject":
                    "The subject COMPLETE", 
                  
                
                  
                        "message":
                    "The COMPLETE message"
                  
                
                  
                       },
                  
                
                  
                       {
                  
                
                  
                        "email":"
                    " test@signnow.com",
                  
                
                  
                        "subject":
                    "COMPLETE subject",
                  
                
                  
                        "message":
                    "COMPLETE message"
                  
                
                  
                       },
                  
                
                  
                       {
                  
                
                  
                        "email":
                    "bob@signnow.com", 
                  
                
                  
                        "subject":
                    "COMPLETED subject", 
                  
                
                  
                        "message":
                    "message COMPLETED",
                  
                
                  
                        "disabled":
                    0
                  
                
                  
                        ]
                  
                
                  
                      }
                  
                
Response
                  { 
                
                    "id": "8755746dea8df75c6856d1fb8c346afe71f2329e"
                
                  }
                

Get document group invite

Returns invite action information for a group invite including the status of each step and action.

Here is the list of possible invite action statuses:

  • "created": invite or action has been created but is not waiting to be signed.
  • "pending": emails have been sent out for this invite action or step and are waiting to be viewed or signed.
  • "fulfilled": actions and steps that have been finished by singing or viewing.
Parameters
  • document_group_id required
    ID of a document group receive information about
  • invite_id required
    ID of an invite to receive information about
Returns

Returns invite action information for a group invite.

GET /documentgroup/{document_group_id}/groupinvite/{invite_id}
                  
                    curl 
                    -X GET
                     \
                  
                
                  
                      https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}} \
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                    { 
                
                    "invite": 
                
                      { 
                
                        "id": "b1c07f1391f042333cf0ca96af5ac9f5b44ca54b", 
                
                        "status": "pending", 
                
                        "steps": [ 
                
                          { 
                
                            "id": "abc07f1391f042333cf0ca96af5ac9f5b44ca54b", 
                
                            "status": "pending", 
                
                            "order": 1, 
                
                            "actions": [ 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "janedoe@signnow.com", 
                
                                "document_id": "dd63da6fbe213863626a61d36b0c13ce61e4a2be", 
                
                                "status": "pending", 
                
                                "role_name": "role6" 
                
                              }, 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "test@test.com", 
                
                                "document_id": "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b", 
                
                                "status": "pending", 
                
                                "role_name": "role2" 
                
                              } 
                
                            ] 
                
                          }, 
                
                          { 
                
                            "id": "def07f1391f042333cf0ca96af5ac9f5b44ca54b", 
                
                            "status": "created", 
                
                            "order": 2, 
                
                            "actions": [ 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "janedoe@signnow.com", 
                
                                "document_id": "dd63da6fbe213863626a61d36b0c13ce61e4a2be", 
                
                                "status": "created", 
                
                                "role_name": "role4" 
                
                              }, 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "test@test.com", 
                
                                "document_id": "dd63da6fbe213863626a61d36b0c13ce61e4a2be", 
                
                                "status": "created", 
                
                                "role_name": "role5" 
                
                              } 
                
                            ] 
                
                          }, 
                
                          { 
                
                            "id": "c1207f1391f042333cf0ca96af5ac9f5b44ca54b", 
                
                            "status": "created", 
                
                            "order": 3, 
                
                            "actions": [ 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "janedoe@signnow.com", 
                
                                "document_id": "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b", 
                
                                "status": "created", 
                
                                "role_name": "role1" 
                
                              }, 
                
                              { 
                
                                "action": "sign", 
                
                                "email": "test@test.com", 
                
                                "document_id": "cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b", 
                
                                "status": "created", 
                
                                "role_name": "role3" 
                
                              } 
                
                            ] 
                
                          } 
                
                        ] 
                
                      } 
                
                    }
                

Get emails of the invite step

Returns emails and other parameters of a particular invite step in the document group invite.

Parameters
  • document_group_id required
    Path parameter: ID of a document group in the invite
  • invite_id required
    Path parameter: ID of the invite.
  • step_id required
    Path parameter: ID of a step in the invite.
Returns

Returns signer's email addresses in the invite step and email settings for each of them.

GET /documentgroup/{document_group_id}/groupinvite/{invite_id}/invitestep/{step_id}/emails
                  
                    curl 
                    -X GET
                     \
                  
                
                  
                        https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}}/invitestep/{{step_id}}/emails
                     \
                  
                
                  
                        -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                  { 
                
                    "emails": [ 
                
                      {
                
                        "email": "signer_1@signnow.com",
                
                        "message": "sales_team@email.com invited you to sign this PDF",
                
                        "subject": "sales_team@email.com Needs Your Signature",
                
                        "reminder": {
                
                          "remind_before": 0,
                
                          "remind_after": 3,
                
                          "remind_repeat": 5
                
                        },
                
                        "expiration_days": 30,
                
                        "disabled": null
                
                      },
                
                      {
                
                        "email": "signer_2@signnow.com",
                
                        "message": "sales_team@email.com invited you to sign this PDF",
                
                        "subject": "sales_team@email.com Needs Your Signature",
                
                        "reminder": {
                
                          "remind_before": 1,
                
                          "remind_after": 2,
                
                          "remind_repeat": 3
                
                        },
                
                        "expiration_days": 30,
                
                        "disabled": null
                
                      },
                
                      {
                
                        "email": "signer_3@signnow.com",
                
                        "message": "sales_team@email.com invited you to sign this PDF",
                
                        "subject": "sales_team@email.com Needs Your Signature",
                
                        "reminder": {
                
                          "remind_before": 0,
                
                          "remind_after": 0,
                
                          "remind_repeat": 0
                
                        },
                
                        "expiration_days": 30,
                
                        "disabled": null
                
                      }
                
                    ]
                
                  }
                

Cancel document group invite

Cancels a group invite. All documents will be unshared with invitees. Any signatures that occurred before canceling will remain on the documents.

Parameters
  • document_group_id required
    ID of a document group to cancel invite for
  • invite_id required
    ID of an invite to cancel
Returns

Returns status of cancellation.

POST /documentgroup/{document_group_id}/groupinvite/{invite_id}/cancelinvite
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                      https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}}/cancelinvite \
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                    { 
                
                     "status": "success"
                
                    }
                

Get pending group invites

Returns all pending invite information as well as invites already signed for a group invite for the user that makes the call. If the user making the call is the document owner, it will return pending invites for that user and ALL actions that have already been fulfilled.

Parameters
  • document_group_id required
    ID of a document group to get pending invites for
  • invite_id required
Returns

Returns all pending invite information as well as invites already signed for a group invite for the user that makes the call.

GET /documentgroup/{document_group_id}/groupinvite/{invte_id}/pendinginvites
                  
                    curl 
                    -X GET
                     \
                  
                
                  
                        https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}}/pendinginvites 
                     \
                  
                
                  
                        -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
Response
                    { 
                
                    "invites": [ 
                
                      { 
                
                        "link": "https://eval.signnow.com/app/session/cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b?access_token=5ee3f8924ec5f413cf3d7ca5b949946e6e7f3410fcbcaa1a4be631487caac463&mobileweb=mobileweb_only", 
                
                        "document_name": "Receipt 1", 
                
                        "inviter_email": "janedoe@SignNow.com", 
                
                        "action": "sign", 
                
                        "status": "fulfilled" 
                
                      }, 
                
                      { 
                
                        "link": "https://eval.signnow.com/app/session/dd63da6fbe213863626a61d36b0c13ce61e4a2be?access_token=9f8282785b859cd35358680d6c1b9c05524a8717e812c279e4e2105a77d93bc0&mobileweb=mobileweb_only", 
                
                        "document_name": "Contract 2", 
                
                        "inviter_email": "janedoe@SignNow.com", 
                
                        "action": "sign", 
                
                        "status": "pending" 
                
                      } 
                
                    ], 
                
                    "document_group_name": "Contracts" 
                
                  }
                

Resend document group invite

Either replaces invitees for a particular step or updates the invite attributes for a user at a particular step. Resend can also be used to resend invites to a single user if the user’s email is specified in the POST JSON body.

Parameters
  • document_group_id required
    ID of a document group to invite for
  • invite_id required
    ID of an invite to update
  • email required
    Email of the user you want to resend email to
Returns

Returns status of the invitation

POST /documentgroup/{document_group_id}/groupinvite/{invite_id}/resendinvites
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                        https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}}/resendinvites
                     \
                  
                
                  
                        -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
                  
                        -H
                     'Content-type: application/json' \
                  
                
                  
                        -d
                     '{
                  
                
                  
                          "email"
                     :"test@email.com",
                  
                
                  
                        }'
                  
                
Response
                    { 
                
                     "status": "success"
                
                    }
                

Update document group invite

Either replaces invitees for a particular step or updates the invite attributes for a user at a particular step.

Parameters
  • document_group_id required
    ID of a document group to update invite for
  • invite_id required
    ID of an invite to update
  • step_id required
    ID of a step replace invitees for
More parameters
  • user_to_update required
  • email required
    Email of a user to update the invite for
  • reminder optional
    In how many days to send a reminder
  • expiration_days optional
    In how many days invite expires
  • replace_with_this_user optional
    Email of the user to replace with
Returns

Returns the update status

POST /documentgroup/{document_group_id}/groupinvite/{invite_id}/invitestep/{step_id}/update
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                        https://api-eval.signnow.com/documentgroup/{{document_group_id}}/groupinvite/{{invite_id}}/invitestep/{{step_id}}/update
                     \
                  
                
                  
                        -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
                  
                        -H
                     'Content-type: application/json' \
                  
                
                  
                        -d
                     '{
                  
                
                  
                          "user_to_update"
                     :"initial.signer@gmail.com",
                  
                
                  
                          "invite_email":
                     {
                  
                
                  
                            "email":
                     "updated.signer@gmail.com", 
                  
                
                  
                            "reminder":
                     0, 
                  
                
                  
                            "expiration_days":
                     30 
                  
                
                  
                          }, 
                  
                
                  
                          "update_invite_action_attributes":
                     [ 
                  
                
                  
                            { 
                  
                
                  
                              "document_id":
                     "c45825eb5a245b2c9840cf04c9ea6c78b494edd4",     
                  
                
                  
                              "allow_reassign":
                     0
                  
                
                  
                              "decline_by_signature":
                     "0"
                  
                
                  
                             } 
                  
                
                  
                          ], 
                  
                
                  
                        "replace_with_this_user":
                     "updated.signer@gmail.com"
                  
                
                  
                      }'
                  
                
Response
                    { 
                
                     "status": "success"
                
                    }
                

Rename document group

Renames document group

Parameters
  • document_group_id required
    ID of a document group to rename
  • group_name required
    A new document group name
Returns

Returns the renaming status.

PUT /document-groups
                  
                    curl 
                    -X PUT
                     \
                  
                
                  
                      https://api-eval.signnow.com/v2/document-groups/{{document_group_id}}
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
                  
                      -H
                     'Content-Type: 
                     application/json'
                     \
                  
                
                  
                      -d
                     '{
                  
                
                  
                         "group_name":
                     "Group name 29"
                  
                
                  
                      }'
                  
                
Response
                  { 
                
                    "status": "success"
                
                  }