--- title: "Edit doc group template recipients" method: PUT path: "/v2/document-group-templates/{doc_group_template_id}/recipients" --- # Edit doc group template recipients `PUT /v2/document-group-templates/{doc_group_template_id}/recipients` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/document-group-templates/{doc_group_template_id}/recipients` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Request body - object - `cc` string[]: List of cc recipient emails. - `order_type` string: 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. - `recipients` object[], required: List of document group template recipients. Should contain at least one recipient. - `name` string, required: Recipient's name. - `email` string: Recipient's email address. - `order` integer, required: Recipient's order of signing. - `documents` object[], required: List of documents, recipient roles, and allowed actions. Should contain at least one document. - `id` string: Document ID. - `role` string: Recipient's role name. - `action` string: Allowed action with a document. Possible values: `view`, `sign`, `approve`. - `attributes` object: Signature invite attributes. - `message` string: Invite email message. - `subject` string: Invite email subject. - `reminder` object: Reminder email settings. Available for `sign` action. - `remind_after` integer: Send the reminder email to the recipient after the set amount of days.`remind_after` must be less than `expiration_days`. - `remind_before` integer: Send the reminder email to the recipient in a set amount of days before the invite expiration.`remind_before` must be less than `expiration_days`. - `remind_repeat` integer: Send the reminder email to the recipient every set amount of days.`remind_repeat` must be less than `attributes.expiration_days`. - `redirect_uri` string: The URL that opens after the recipient completes the document. - `authentication` object: Recipient authentication settings. Available for recipients with `sign` and `approve` actions. Can not be used when `allow_forwarding` is set to `true`. - `type` string: Type of the recipient authentication. Can be `phone` or `password`. - `phone` string: The phone number for the recipient's authentication. Used with type `phone`. - `value` string: The password to unlock the document group template. Used with type `password`. - `method` string: Authentication method. Used with type `phone`. Should be `sms` or `phone_call`. - `sms_message` string: Custom SMS message sent to the recipient, containing the {password} placeholder. Used with the `sms` method. Without this parameter, the signer receives a default SMS with an autogenerated password (unlock code): “SignNow document invite unlock code: 123456.” - `i_am_recipient` boolean: Set to `true` if the document sender is also a recipient. Available for `sign` action. - `expiration_days` integer: Days until the invite expires. Available for `sign`and `approve` actions. - `redirect_target` string: Determines whether to open the redirect link in the new tab in the browser, or in the same tab after the signing session. Possible values: `blank` - opens the link in the new tab, `self` - opens the link in the same tab. - `allow_forwarding` boolean: Whether recipients are allowed to reassign the invite to a different email address. Available for `sign` action. - `close_redirect_uri` string: The link that opens when a signer clicks **Save Progress and Finish Later** during a signing session or **Close** in view mode. Available for `sign` action. - `show_decline_button` boolean: Whether to show the Decline button on signature fields. Available for `sign` action. - `decline_redirect_uri` string: The URL that opens after the recipient declines the document. Available for `sign` action. - `general_reminder` object: Default `reminder` applied to all recipients in the invite. - `remind_after` integer: Days after invite is sent before a reminder is delivered. Must be less than `general_expiration_days`. - `remind_before` integer: Days before expiration when a reminder is delivered. Must be less than `general_expiration_days`. - `remind_repeat` integer: Days between repeated reminders. - `unmapped_documents` object[]: List of recipients that are not assigned to documents in the document group template. - `id` string: Document ID. - `role` string: Recipient's role name. - `action` string: Allowed action with a document. Possible values: `view`, `sign`, `approve`. - `general_expiration_days` integer: Default `expiration_days` applied to all recipients in the invite. Min: `1`, Max: `180`. Default: `30`. - `allowed_unmapped_sign_documents` object[]: List of recipients with unassigned documents that need to be filled out and completed. - `id` string: Document ID. - `role` string: Recipient's role name. - `recipient` string: Recipient's name. ## Response `200` Successful response. - object - `data` object: Recipients of the document group, CC recipients, and documents not yet assigned to a recipient. - `cc` unknown[]: Email addresses of CC recipients. - unknown - `recipients` object[]: Recipients of the document group invite. - `name` string: Name of the recipient. - `email` string: Email address of the recipient. - `order` integer: Position of the recipient in the signing order. - `documents` object[]: Documents the recipient receives, with the role and action for each. - `id` string: ID of the document. - `role` string: Name of the recipient role in the document. - `action` string: Action the recipient must perform in the document: `sign`, `view`, or `approve`. - `attributes` object: Invite settings of the recipient. - `email_group` object: Email group of the recipient. `id` is `null` if the recipient is not a group. - `id` string: ID of the email group. `null` if the invite was sent to a single recipient. - `phone_invite` string: Phone number for an SMS invite. `null` for email invites. - `general_reminder` string: Default reminder settings applied to all recipients. `null` if not set. - `general_expiration_days` string: Default number of days before the invite expires, applied to all recipients. `null` if not set. - `allowed_unmapped_sign_documents` unknown[]: Documents with `sign` actions that are allowed to stay unassigned to a recipient. - unknown ## Other responses - `400`: - Wrong, expired, or missing token. - `document_group_template_id` is incorrect. **Validation errors**: - Recipient-specific validation errors: - `recipients` type is incorrect. - `recipients` is empty. - `recipients` should contain at least one element. - Document-specific validation errors: - Document `id` is not part of the document group template. - `documents` type is incorrect. - `documents` value is empty. - Allowed_unmapped_sign_documents validation errors. Examples: - `allowed_unmapped_sign_documents` type is incorrect. - `allowed_unmapped_sign_documents` recipients or documents are not in the document group template. - CC field validation errors. Examples: - `cc` type is incorrect. - `cc` contains too many elements. - `cc` element value is not a valid email address. --- [API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)