---
title: "Create link for doc group"
method: POST
path: "/v2/document-groups/{document_group_id}/embedded-sending"
---

# Create link for doc group

`POST /v2/document-groups/{document_group_id}/embedded-sending`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/document-groups/{document_group_id}/embedded-sending`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/document-groups/:document_group_id/embedded-sending/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to create a link for embedded document group sending. 

Add the `type` attribute to the payload to specify the sending step at which the embedded link should open and to control what actions the sender can perform. 
- `manage`: The link opens on the **Add documents to document group page** (default).
- `edit`: The link opens in the editor, allowing the sender to add fields and send the invite.
- `send-invite`: The link opens on the **Send Invite** page.

Use the request body attributes to configure redirect options, specify link expiration, and customize the sender’s email and name appearance.

For more information, see [Embedded sending guide](/docs/guides-embedded-sending).

## Request body

- object
  - `type` string: Specifies the sending step at which the embedded link should open: `manage` — opens the link on the Add documents to document group page (default); `edit`— opens the link in the editor; `send-invite` — opens the link on the Send Invite page.
  - `from_name` string: Use this attribute to customize the name that appears: 1) on the Send Invite page (From, Invite Email Subject, and Invite Email Message); 2) in the invite and reassign emails: in email subject and email body; 3) in the signing session: as the name in From in the header and on the detailed From card.
  - `from_email` string: Use this attribute to customize the email address that appears: 1) [part before @]on the Send Invite page (From, Invite Email Subject, and Invite Email Message) 2) in the invite and reassign emails: [part before @] in email subject and email body; when clicking Contact Sender and in Reply-to; 3) in the signing session: as the email in From in the header and on the detailed From card; when clicking Contact Sender in the More Actions menu and on the detailed From card.
  - `redirect_uri` string: The page that opens after embedded sending has been set up. Required if `redirect_target` is added.
  - `link_expiration` integer: Specifies how many minutes the link remains active. The allowed range is 15 to 45 minutes.
  - `redirect_target` string: Determines whether to open the redirect link in a new tab in the browser or in the same tab. Possible values: `blank` - opens the link in a new tab, `self` - opens the link in the same tab (default).

## Response `200`

Returns the link for embedded sending.

- object
  - `data` object, required: Embedded sending link.
    - `url` string: Embedded sending link for the document group.

## Other responses

- `400`: * Wrong, expired, or missing token. * Incorrect payload. **Validation errors**: * `redirect_uri` is not a string. * Empty `redirect_uri`. * `redirect_uri` is longer than 2048 characters. * `redirect_uri` is not a correct URL. * UTF 4-byte characters in `redirect_uri` are not supported. * `link_expiration` is not an integer. * `link_expiration` must be between 15 and 45. * Custom `link_expiration` is more than 43200 minutes. * `redirect_target` is not a string. * Incorrect `redirect_target`. Allowed values: `self`, `blank`. * `redirect_uri` is required if `redirect_target` is added. * The `type` is not a string. * The `type` value is incorrect.
- `403`: The user does not own the document group.
- `404`: Document group is not found.

---

[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)