SIsignnow

Complete DG correction

This endpoint allows API users to complete a document group correction and apply the new signers, documents, and invite settings. With this endpoint, you can:

  • Change the signers and viewers of the document group
  • Update the invite settings
  • Reorder and remove documents that were not signed yet
  • Add new documents to the document group

Before completing the correction, initiate it.

Partially signed invites

A recipient counts as having signed once they complete their signing action or fill in at least one field on any document in the group. The document does not need to be fully completed.

When some recipients have already signed:

  • Add new signers and viewers to the last step that was at least partially signed, or to any later step. Earlier steps are locked.
  • A recipient who already signed a document in the last signed step can be added to that step as a viewer of another document.
  • The role of a recipient who already signed keeps its email address.

Steps that were cancelled when the correction started are recreated when you complete it:

  • If the last signed step is complete, the next step's invites are sent right away. Adding only viewers to the completed step does not change this.
  • If you add a signer to the last completed step, the step returns to pending. The next step's invites are sent once the new signer finishes.

For example, an invite has three steps, and steps 1 and 2 are signed. You can add new signers to steps 2 and 3. If you add a signer to step 2, step 3's invites are sent after that signer completes step 2.

Short-link signers

To give a signer a link instead of an email invite, set is_short_link_invite to true and omit email. Add short-link signers to the first step (order: 1). A step can include several of them.

  • The endpoint returns 204 with no body. Get each signer's link from short_link_url in Get document group info (v.2). In that response, signer_email shows the guest address generated for the signer, such as guest_signer_123456789012@no.reply.
  • Every completed correction generates a new link for each short-link signer. Share the link from the latest response.
  • Short-link signers support authentication and expiration_days.

Short links can also be created with Create/edit signing link for doc group and Update doc group invite.

put/v2/document-groups/{dg_id}/invite/{dg_invite_id}

Request

Path parameters

ID of the document group.

ID of the document group invite.

Request body

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.

mail_providerstring

Defines the from field of the invite to sign email and other emails that are connected to the invite (cc, reminder, forward, reassign, and cancel). Possible values: ‘default’ or an email address. To use an email address, first, you must connect it to the SignNow account at the UI. If set to ‘default’, the default email address that had been set up is used.

client_timestampinteger required

The timestamp of when the correction was completed.

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

{
  "invites": [
    {
      "signers": [
        {
          "redirect_uri": "https://www.signnow.com/",
          "redirect_target": "blank",
          "close_redirect_uri": "https://www.signnow.com/",
          "decline_redirect_uri": "https://www.signnow.com/"
        }
      ]
    }
  ]
}

Response

Success, no content

object required

Changes

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