SIsignnow

Edit doc group recipients

This endpoint allows API users to add or remove document group recipients. Users can edit recipients' emails, roles and role actions, signing order, CC recipients, and more.

You cannot edit recipients for a document group with an active signature invite.

To pre-fill recipients' information when sending an invite, name must match role.

Recipients and roles in document groups

  • The same email address can have multiple roles in a document group — for example, if the recipient acts as "Agent" in one document and "Manager" in another.
  • The API creates a separate entry for each role, so the same email address may appear multiple times in the response.

Example: If recipient@example.com is assigned as "Agent" in Document A and "Manager" in Document B, the response will contain two separate entries for recipient@example.com — one per role.

Mapping tip: When mapping recipients in your integration, group by email address rather than by role name.

put/v2/document-groups/{document_group_id}/recipients

Request

Path parameters

ID of the document group.

Request body

ccstring[]

List of email addresses for CC recipients.

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.

general_expiration_daysinteger

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

Example request

{
  "recipients": [
    {
      "name": "Signer",
      "email": "signer@email.com",
      "order": 1,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013ae4af",
          "role": "Signer",
          "action": "sign"
        }
      ],
      "attributes": {
        "message": "{fullName} shared {documentName} for signing.",
        "subject": "Review and sign {documentName}",
        "reminder": {
          "remind_after": 5,
          "remind_before": 5,
          "remind_repeat": 5
        },
        "redirect_uri": "https://www.signnow.com/",
        "authentication": {
          "type": "phone",
          "phone": "+12345678",
          "value": "123456",
          "method": "phone_call",
          "sms_message": "Enter the password {password} to unlock your document."
        },
        "expiration_days": 10,
        "redirect_target": "blank",
        "close_redirect_uri": "https://www.signnow.com/",
        "decline_redirect_uri": "https://www.signnow.com/"
      },
      "email_group": {
        "id": "296f8dc89ed0d6de89fc7e5615371aaae19e12e1"
      }
    }
  ]
}

Response

Successfully updated document group recipients.

Changes

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