---
title: "Invite with redirects"
url: "https://docs.signnow.com/docs/redirects-configuration"
type: "page"
section: "Documentation"
slug: "redirects-configuration"
---

# Invite with redirects

## About redirects configuration

Set up pages that open for signers upon signing, closing, or declining an invite.

Use `redirect_target` to define how the redirect link is opened:

- `self`: in the same tab.
- `blank`: in a new tab.

| Invite type                                                                                                                                                                                                                                       | Redirect types                                                                                                                                                                                                                                                                                                                                                                           |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Field invite (both [document](/docs/document-field-invite/operations/post-field_invite) and [document group](/docs/doc-group-field-invite/operations/invite-to-sign-document-group))                                  | <ul><li>`redirect_uri`: a recipient completes a document or document group and clicks **Finish**.</li><li>`close_redirect_uri`: a recipient clicks **Save progress and finish later** or **Close**.</li><li>`decline_redirect_uri`: a recipient clicks **Do Not Consent** or **Decline**.</li></ul>For a document field invite, you can set a separate `close_redirect_uri` for viewers. |
| Freeform invite (both [document](/docs/document-field-invite/operations/post-field_invite) and [document group](/docs/doc-group-freeform-invite/operations/post-v2-document-groups-document_group_id-free-form-invites)                     | <ul><li>`redirect_uri`: a recipient clicks **Done**.</li><li>`close_redirect_uri`: a recipient clicks **Close**.</li></ul>                                                                                                                                                                                                                                                               |
| Embedded invite (both [document](/docs/document-embedded-signing/operations/create-embedded-signing-invite) and [document group](/docs/doc-group-embedded-signing/operations/create-embedded-invite-document-group)) | <ul><li>`redirect_uri`: a recipient completes a document or document group and clicks **Finish**.</li><li>`close_redirect_uri`: a recipient clicks **Save progress and finish later** or **Close**.</li><li>`decline_redirect_uri`: a recipient clicks **Do Not Consent** or **Decline**.</li></ul>                                                                                      |
| Embedded sending (both [document](/docs/embedded-sending/operations/post-v2-documents-document_id-embedded-sending) and [document group](/docs/embedded-sending/operations/post-v2-document-groups-document_group_id-embedded-sending))                 | <ul><li>`redirect_uri`: a recipient clicks **Send invite** or **Save and Close**.</li></ul>                                                                                                                                                                                                                                                                                              |
| Embedded editor (both [document](/docs/embedded-editor/operations/post-v2-documents-documentUniqueId-embedded-editor) and [document group](/docs/embedded-editor/operations/post-v2-document-groups-document_group_id-embedded-editor))                      | <ul><li>`redirect_uri`: a recipient clicks **Save and Close**.</li></ul>                                                                                                                                                                                                                                                                                                                 |

## Send a document field invite with redirects

### Step 1: Authentication

[Generate](/docs/authentication) a bearer token to authenticate further requests.

### Step 2: Upload document

[Upload](/docs/entities) a document to be signed.

### Step 3: Add fields

[Add](/docs/fields) fields to the document.

### Step 4. Get role ID

Make a [Get document](/docs/document/operations/get-document) request to extract the role or role ID.

```json

curl -X GET \
https://api.signnow.com/document/{{document_id}} \
-H 'Authorization: Bearer {{access_token}}' \

```

The roles array lists role names and IDs. You need either a role or role ID, but you can use both. If you use both, ensure the roles and IDs correspond.

```json

"roles": [
    {
        "unique_id": "6e9580fa76ba4edca18fa6e680a36d10a6bab503",
        "signing_order": "1",
        "name": "Signer 1"
        }
]

```

<!-- theme: info -->

> **Note**: In the invite, all the roles from the document must be assigned to signers.

### Step 5: Send invite with redirects

Send a [document field invite](/docs/document-field-invite/operations/post-field_invite) redirect settings for a signer and a viewer.

```json
curl -X POST \
https://api.signnow.com/document/{{document_id}}/invite \
-H 'Authorization: Bearer {{access_token}}'\
-H 'Content-Type: application/json' \
-d '{
    "to": [
        {
            "email": "signer@email.com",
            "role": "Signer 1",
            "role_id": "6e9580fa76ba4edca18fa6e680a36d10a6bab503",
            "order": 1,
            "redirect_uri": "https://unique-solutions.com",
            "decline_redirect_uri": "https://unique-solutions.com",
            "close_redirect_uri": "https://unique-solutions.com",
            "redirect_target": "blank",
            "subject": "New document",
            "message": "You've got a new document to sign."
        }
    ],
    "from": "sender@email.com",
    "viewers": [
        {
            "email": "viewer@email.com",
            "role": "Viewer 1",
            "order": 1,
            "close_redirect_uri": "https://unique-solutions.com",
            "redirect_target": "blank",
            "subject": "New document",
            "message": "You've got a new document to review."
        }
    ]
}'
```

## Try out in Postman

[Access](https://www.postman.com/signnow-api/signnow-public-collection/collection/65kpga4/signnow-extended-signing-session-features) this flow in Postman and customize your signature experience using redirects.


---
*Full page: https://docs.signnow.com/docs/redirects-configuration*