SIsignnow

Invite to sign doc group

This endpoint allows users to create an invite for signing a document group. You can configure a multistep workflow, where different recipients act on the document group at different stages.

Recipients can receive the invite by email or by SMS: identify a recipient by email for email delivery or by phone_invite for SMS delivery. You can combine email and SMS recipients in a single request. For more information, see the SMS invite guide.

Each invite step includes:

  • order: the sequence number of the step.

  • invite_actions: an array of objects specifying who is invited and the action they must perform:

    • sign: The recipient can sign or fill out the document.
    • approve: The recipient can review the document to approve or decline it.
    • view: The recipient can only review the document without making changes.

  • invite_emails: an array for customizing the emails sent to recipients at that step.

  • invite_sms: an array for customizing the SMS invites sent to recipients at that step: custom SMS text (sms_message), expiration, and reminder settings.

Once all invite actions in a step are completed, the system sends the emails or SMS messages for the next step. When all steps are complete, completion emails are triggered.

To invite a signing group, use the email_groups field. A signing group includes multiple email addresses, and the step is marked complete as soon as any member of the group signs. You can either use an existing group or define a new one by providing a 40-character ID, a group name, and the list of recipient emails.

To create a signing group separately, see Create contact group.

Learn more about an Invite to sign a document group.

<details>

<summary>Use additional attributes to customize signing experience</summary>

ParameterDescriptionExample
reassignA recipient can forward the invite by clicking More Actions > Forward Invite and entering an email address.<img src="/reference-assets/images/Screenshots with attribute explanations/Field invite/reassign.png" alt="Forward invite">
force_new_signatureA recipient must create a new signature for each signature field.<img src="/reference-assets/images/Screenshots with attribute explanations/Field invite/Force_new_signature.png" alt="Force new signature">
prefill_signature_nameA string with a signature name that appears when a signer clicks a signature field. The signer can edit the signature.
required_preset_signature_nameA string with a signature name that appears when a signer clicks a signature field. The signer cannot edit the signature.
decline_by_signatureWhen a signer clicks a signature field, they see two options: sign the fields and decline the document group.<img src="/reference-assets/images/Screenshots with attribute explanations/Field invite/Decline_by_signature.png" alt="Decline by signature">
authentication_typeRequires a recipient to enter a password or a code before viewing the document group. For more information, see Two-factor authentication.<img src="/reference-assets/images/Screenshots with attribute explanations/Field invite/DG_authentication.png" alt="Password_authentication">
</details>
post/documentgroup/{document_group_id}/groupinvite

Request

Path parameters

The ID of the document group

Request body

ccstring[]

Array of cc email addresses.

order_typestring

Recipient routing rule applied to all recipients in the invite. at_the_same_time - all at once; recipient_order - sequential by order parameter; advanced_order - advanced rules.

sign_as_mergedboolean

If true, allows API user to send an invite which opens as merged document group in a single document.

client_timestampinteger

The timestamp of the document group invite.

general_expiration_daysinteger

Default expiration_days applied to all recipients in the invite. Min: 1, Max: 180. Default: 30.

general_expiration_timeinteger

Default expiration timestamp (Unix time, seconds) applied to all recipients in the invite.

Example request

{
  "invite_steps": [
    {
      "invite_sms": [
        {
          "sms_message": "Hi, here is a document for signature from {sender_email}",
          "phone_invite": "+14075985199"
        }
      ],
      "invite_actions": [
        {
          "phone_invite": "+14075985199",
          "redirect_uri": "https://www.signnow.com/",
          "prefill_signature_name": "Jane Doe",
          "required_preset_signature_name": "Jane Doe"
        }
      ]
    }
  ],
  "general_expiration_days": 30
}

Response

Document group invite created.

idstring

ID of the created document group invite.

pending_invite_linkstring

Link for signers with pending invites.

Changes

No recorded changes to this operation across all 1 revision of this API.