SIsignnow

Edit doc group template recipients

This endpoint allows API users to edit the recipients of a document group template. Users can edit recipients' emails, roles, signing order, document attributes, signature invite email attributes, and authentication settings.

put/v2/document-group-templates/{doc_group_template_id}/recipients

Request

Path parameters

ID of the document group template.

Request body

ccstring[]

List of cc recipient emails.

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

{
  "cc": [
    "test1@email.com, test2@email.com"
  ],
  "recipients": [
    {
      "name": "Jane Doe",
      "email": "signer@email.com",
      "order": 1,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a7f77",
          "role": "Signer"
        }
      ],
      "attributes": {
        "message": "test message",
        "subject": "test subject",
        "reminder": {
          "remind_after": 10,
          "remind_before": 5,
          "remind_repeat": 5
        },
        "redirect_uri": "https://www.signnow.com/",
        "authentication": {
          "type": "phone",
          "phone": "+12345678",
          "value": "123456",
          "method": "sms",
          "sms_message": "Enter the password {password} to unlock your document."
        },
        "expiration_days": 20,
        "redirect_target": "blank",
        "close_redirect_uri": "https://www.signnow.com/",
        "decline_redirect_uri": "https://www.signnow.com/"
      }
    }
  ],
  "unmapped_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a7f77",
      "role": "Signer",
      "action": "sign"
    }
  ],
  "allowed_unmapped_sign_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a400a",
      "role": "Signer",
      "recipient": "Jack Finkelstein"
    }
  ]
}

Response

Successful response.

Changes

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