---
title: "Edit doc group template recipients"
url: "https://docs.signnow.com/docs/document-group-template/operations/put-v2-document-group-templates-document_group_template_id-recipients"
type: "endpoint"
section: "document-group-template"
slug: "document-group-template/operations/put-v2-document-group-templates-document_group_template_id-recipients"
method: "PUT"
path: "/v2/document-group-templates/{doc_group_template_id}/recipients"
operation_id: "put-v2-document-group-templates-document_group_template_id-recipients"
authorization: "bearer"
---

# Edit doc group template recipients

`PUT /v2/document-group-templates/{doc_group_template_id}/recipients`

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

## Authorization

bearer

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `doc_group_template_id` | string | Yes | ID of the document group template. |

## Request Body

**Schema**

```json
{
  "type": "object",
  "required": [
    "recipients"
  ],
  "properties": {
    "cc": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "test1@email.com, test2@email.com"
      },
      "maxItems": 100,
      "description": "List of cc recipient emails."
    },
    "order_type": {
      "enum": [
        "at_the_same_time",
        "recipient_order",
        "advanced_order",
        null
      ],
      "type": "string",
      "x-nullable": true,
      "description": "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": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "order",
          "documents"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Jane Doe",
            "description": "Recipient's name."
          },
          "email": {
            "type": "string",
            "example": "signer@email.com",
            "description": "Recipient's email address."
          },
          "order": {
            "type": "integer",
            "example": 1,
            "description": "Recipient's order of signing."
          },
          "documents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
                  "description": "Document ID."
                },
                "role": {
                  "type": "string",
                  "example": "Signer",
                  "description": "Recipient's role name.\n"
                },
                "action": {
                  "type": "string",
                  "description": "Allowed action with a document. Possible values: `view`, `sign`, `approve`."
                }
              }
            },
            "description": "List of documents, recipient roles, and allowed actions.\nShould contain at least one document."
          },
          "attributes": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "example": "test message",
                "description": "Invite email message. "
              },
              "subject": {
                "type": "string",
                "example": "test subject",
                "description": "Invite email subject. "
              },
              "reminder": {
                "type": "object",
                "properties": {
                  "remind_after": {
                    "type": "integer",
                    "example": 10,
                    "description": "Send the reminder email to the recipient after the set amount of days.`remind_after` must be less than `expiration_days`.\n"
                  },
                  "remind_before": {
                    "type": "integer",
                    "example": 5,
                    "description": "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`.\n"
                  },
                  "remind_repeat": {
                    "type": "integer",
                    "example": 5,
                    "description": "Send the reminder email to the recipient every set amount of days.`remind_repeat` must be less than `attributes.expiration_days`.\n"
                  }
                },
                "description": "Reminder email settings. Available for `sign` action."
              },
              "redirect_uri": {
                "type": "string",
                "example": "https://www.signnow.com/",
                "description": "The URL that opens after the recipient completes the document.",
                "x-stoplight": {
                  "id": "umhswj8fdrrxq"
                }
              },
              "authentication": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "phone",
                    "description": "Type of the recipient authentication. Can be `phone` or `password`.\n"
                  },
                  "phone": {
                    "type": "string",
                    "example": "+12345678",
                    "description": "The phone number for the recipient's authentication. Used with type `phone`.\n"
                  },
                  "value": {
                    "type": "string",
                    "example": "123456",
                    "description": "The password to unlock the document group template. Used with type `password`.\n"
                  },
                  "method": {
                    "type": "string",
                    "example": "sms",
                    "description": "Authentication method. Used with type `phone`. Should be `sms` or `phone_call`.\n"
                  },
                  "sms_message": {
                    "type": "string",
                    "example": "Enter the password {password} to unlock your document.",
                    "description": "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): \u201cSignNow document invite unlock code: 123456.\u201d"
                  }
                },
                "description": "Recipient authentication settings. Available for recipients with `sign` and `approve` actions. Can not be used when `allow_forwarding` is set to `true`."
              },
              "i_am_recipient": {
                "type": "boolean",
                "description": "Set to `true` if the document sender is also a recipient. Available for `sign` action."
              },
              "expiration_days": {
                "type": "integer",
                "example": 20,
                "maximum": 180,
                "minimum": 3,
                "description": "Days until the invite expires. Available for `sign`and `approve` actions."
              },
              "redirect_target": {
                "type": "string",
                "example": "blank",
                "description": "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.",
                "x-stoplight": {
                  "id": "30rvyfzrgkx7k"
                }
              },
              "allow_forwarding": {
                "type": "boolean",
                "description": "Whether recipients are allowed to reassign the invite to a different email address. Available for `sign` action."
              },
              "close_redirect_uri": {
                "type": "string",
                "example": "https://www.signnow.com/",
                "description": "The link that opens when a signer clicks\u00a0**Save Progress and Finish Later**\u00a0during a signing session or\u00a0**Close**\u00a0in view mode. Available for `sign` action.",
                "x-stoplight": {
                  "id": "0srtnucjz3tia"
                }
              },
              "show_decline_button": {
                "type": "boolean",
                "description": "Whether to show the Decline button on signature fields. Available for `sign` action."
              },
              "decline_redirect_uri": {
                "type": "string",
                "example": "https://www.signnow.com/",
                "description": "The URL that opens after the recipient declines the document. Available for `sign` action.",
                "x-stoplight": {
                  "id": "sg8obh2zcvrlp"
                }
              }
            },
            "description": "Signature invite attributes."
          }
        }
      },
      "description": "List of document group template recipients.\nShould contain at least one recipient."
    },
    "general_reminder": {
      "type": "object",
      "properties": {
        "remind_after": {
          "type": "integer",
          "description": "Days after invite is sent before a reminder is delivered. Must be less than `general_expiration_days`."
        },
        "remind_before": {
          "type": "integer",
          "description": "Days before expiration when a reminder is delivered. Must be less than `general_expiration_days`."
        },
        "remind_repeat": {
          "type": "integer",
          "description": "Days between repeated reminders."
        }
      },
      "x-nullable": true,
      "description": "Default `reminder` applied to all recipients in the invite."
    },
    "unmapped_documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
            "description": "Document ID."
          },
          "role": {
            "type": "string",
            "example": "Signer",
            "description": "Recipient's role name."
          },
          "action": {
            "type": "string",
            "example": "sign",
            "description": "Allowed action with a document. Possible values: `view`, `sign`, `approve`."
          }
        }
      },
      "description": "List of recipients that are not assigned to documents in the document group template."
    },
    "general_expiration_days": {
      "type": "integer",
      "maximum": 180,
      "minimum": 1,
      "x-nullable": true,
      "description": "Default `expiration_days` applied to all recipients in the invite. Min: `1`, Max: `180`. Default: `30`."
    },
    "allowed_unmapped_sign_documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aYYYY",
            "description": "Document ID."
          },
          "role": {
            "type": "string",
            "example": "Signer",
            "description": "Recipient's role name."
          },
          "recipient": {
            "type": "string",
            "example": "Jack Finkelstein",
            "description": "Recipient's name."
          }
        }
      },
      "description": "List of recipients with unassigned documents that need to be filled out and completed."
    }
  },
  "x-examples": {
    "Example 1": {
      "cc": [
        "test@test.com",
        "test2@test.com"
      ],
      "recipients": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@email.com",
          "order": 1,
          "documents": [
            {
              "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
              "role": "Signer",
              "action": "sign"
            },
            {
              "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
              "role": "Signer",
              "action": "sign"
            }
          ],
          "attributes": {
            "message": "test message 1",
            "subject": "test subject 1",
            "reminder": {
              "remind_after": 10,
              "remind_before": 10,
              "remind_repeat": 10
            },
            "authentication": {
              "type": "phone",
              "phone": "+1234567",
              "method": "sms",
              "sms_message": "Your password is {123456}."
            },
            "i_am_recipient": false,
            "expiration_days": 20,
            "allow_forwarding": false,
            "show_decline_button": true
          }
        },
        {
          "name": "Jack Finkelstein",
          "email": "jack.finkelstein@email.com",
          "order": 2,
          "documents": [
            {
              "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
              "role": "Approver",
              "action": "approve"
            },
            {
              "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
              "role": "Approver",
              "action": "approve"
            }
          ],
          "attributes": {
            "message": "test message 2",
            "subject": "test subject 2",
            "authentication": {
              "type": "password",
              "value": "123456"
            },
            "i_am_recipient": false,
            "expiration_days": 20
          }
        }
      ],
      "unmapped_documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a749f",
          "role": "Signer",
          "action": "sign"
        }
      ],
      "allowed_unmapped_sign_documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a749f",
          "role": "Signer",
          "recipient": "Recipient 1"
        }
      ]
    }
  }
}
```

**Example** (`Example 1`)

```json
{
  "cc": [
    "test1@email.com, test2@email.com"
  ],
  "order_type": "recipient_order",
  "recipients": [
    {
      "name": "Jane Doe",
      "email": "signer@email.com",
      "order": 1,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
          "role": "Signer",
          "action": "string"
        }
      ],
      "attributes": {
        "message": "test message",
        "subject": "test subject",
        "reminder": {
          "remind_after": 10,
          "remind_before": 5,
          "remind_repeat": 5
        },
        "authentication": {
          "type": "phone",
          "phone": "+12345678",
          "value": "123456",
          "method": "sms",
          "sms_message": "Your password is {123456}."
        },
        "i_am_recipient": true,
        "expiration_days": 20,
        "allow_forwarding": true,
        "show_decline_button": true
      }
    }
  ],
  "general_reminder": {
    "remind_after": 3,
    "remind_before": 5,
    "remind_repeat": 7
  },
  "unmapped_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
      "role": "Signer",
      "action": "sign"
    }
  ],
  "general_expiration_days": 30,
  "allowed_unmapped_sign_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aYYYY",
      "role": "Signer",
      "recipient": "Jack Finkelstein"
    }
  ]
}
```

## Responses

### 200

Success.

**Example** (`Example 1`)

```json
{
  "cc": [
    "test@test.com",
    "test2@test.com"
  ],
  "order_type": null,
  "recipients": [
    {
      "name": "Jane Doe",
      "email": "jane.doe@email.com",
      "order": 1,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
          "role": "Signer",
          "action": "sign"
        },
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
          "role": "Signer",
          "action": "sign"
        }
      ],
      "attributes": {
        "message": "test message 1",
        "subject": "test subject 1",
        "reminder": {
          "remind_after": 10,
          "remind_before": 10,
          "remind_repeat": 10
        },
        "expiration_days": 20
      },
      "authentication": {
        "type": "phone",
        "phone": "+1234567",
        "method": "sms",
        "sms_message": "Your password is {123456}."
      },
      "i_am_recipient": false,
      "allow_forwarding": false,
      "show_decline_button": true
    },
    {
      "name": "Jack Finkelstein",
      "email": "jack.finkelstein@email.com",
      "order": 2,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
          "role": "Approver",
          "action": "approve"
        },
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
          "role": "Approver",
          "action": "approve"
        }
      ],
      "attributes": {
        "message": "test message 2",
        "subject": "test subject 2",
        "authentication": {
          "type": "password",
          "value": "123456"
        },
        "i_am_recipient": false,
        "expiration_days": 20
      }
    }
  ],
  "general_reminder": {
    "remind_after": 3,
    "remind_before": 5,
    "remind_repeat": 7
  },
  "general_expiration_days": 30,
  "allowed_unmapped_sign_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a749f",
      "role": "Signer",
      "recipient": "Recipient 1"
    }
  ]
}
```

**Example** (`Successful response`)

```json
{
  "cc": [
    "test@test.com",
    "test2@test.com"
  ],
  "order_type": null,
  "recipients": [
    {
      "name": "Jane Doe",
      "email": "jane.doe@email.com",
      "order": 1,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
          "role": "Signer",
          "action": "sign"
        },
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
          "role": "Signer",
          "action": "sign"
        }
      ],
      "attributes": {
        "message": "test message 1",
        "subject": "test subject 1",
        "reminder": {
          "remind_after": 10,
          "remind_before": 10,
          "remind_repeat": 10
        },
        "expiration_days": 20
      },
      "authentication": {
        "type": "phone",
        "phone": "+1234567",
        "method": "sms",
        "sms_message": "Your password is {123456}."
      },
      "i_am_recipient": false,
      "allow_forwarding": false,
      "show_decline_button": true
    },
    {
      "name": "Jack Finkelstein",
      "email": "jack.finkelstein@email.com",
      "order": 2,
      "documents": [
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX",
          "role": "Approver",
          "action": "approve"
        },
        {
          "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a74aa",
          "role": "Approver",
          "action": "approve"
        }
      ],
      "attributes": {
        "message": "test message 2",
        "subject": "test subject 2",
        "authentication": {
          "type": "password",
          "value": "123456"
        },
        "i_am_recipient": false,
        "expiration_days": 20
      }
    }
  ],
  "general_reminder": {
    "remind_after": 3,
    "remind_before": 5,
    "remind_repeat": 7
  },
  "general_expiration_days": 30,
  "allowed_unmapped_sign_documents": [
    {
      "id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013a749f",
      "role": "Signer",
      "recipient": "Recipient 1"
    }
  ]
}
```

### 400

- `document_group_template_id` is incorrect.
- The access token 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.




**Example** (`Example 1`)

```json
{
  "errors": [
    {
      "code": 13022001,
      "message": "Access to DocumentGroupTemplate is denied"
    }
  ]
}
```

**Example** (`DGT id is incorrect`)

```json
{
  "errors": [
    {
      "code": 13022001,
      "message": "Access to DocumentGroupTemplate is denied"
    }
  ]
}
```

**Example** (`Access token is incorrect`)

```json
{
  "code": 1537,
  "error": "invalid_token"
}
```

**Example** (`CC field validation errors`)

```json
{
  "errors": [
    {
      "code": 13023007,
      "message": "The `cc` value should contain 100 element or less."
    }
  ]
}
```

**Example** (`Document-specific validation errors`)

```json
{
  "errors": [
    {
      "code": 13023022,
      "message": "The `recipient` element `documents` value should be of type array."
    }
  ]
}
```

**Example** (`Recipient-specific validation errors`)

```json
{
  "errors": [
    {
      "code": 13023001,
      "message": "The `recipients` value should be of type array."
    }
  ]
}
```

**Example** (`Allowed_unmapped_sign_documents validation errors`)

```json
{
  "errors": [
    {
      "code": 13023035,
      "message": "The `allowed_unmapped_sign_document` element `id` value should not be blank."
    }
  ]
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X PUT \
  "https://api.signnow.com/v2/document-group-templates/{doc_group_template_id}/recipients" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cc": ["test1@email.com, test2@email.com"], "order_type": "recipient_order", "recipients": [{"name": "Jane Doe", "email": "signer@email.com", "order": 1, "documents": [{"id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX", "role": "Signer", "action": "string"}], "attributes": {"message": "test message", "subject": "test subject", "reminder": {"remind_after": 10, "remind_before": 5, "remind_repeat": 5}, "authentication": {"type": "phone", "phone": "+12345678", "value": "123456", "method": "sms", "sms_message": "Your password is {123456}."}, "i_am_recipient": true, "expiration_days": 20, "allow_forwarding": true, "show_decline_button": true}}], "general_reminder": {"remind_after": 3, "remind_before": 5, "remind_repeat": 7}, "unmapped_documents": [{"id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aXXXX", "role": "Signer", "action": "sign"}], "general_expiration_days": 30, "allowed_unmapped_sign_documents": [{"id": "b12e4a885b513a6d9c4c2e7c2b7fa06a013aYYYY", "role": "Signer", "recipient": "Jack Finkelstein"}]}'
```

---
*Full reference: https://docs.signnow.com/docs/document-group-template/operations/put-v2-document-group-templates-document_group_template_id-recipients*