---
title: "Create scheduled invite"
method: POST
path: "/documentgroup/{document_group_id}/scheduled-invite"
---

# Create scheduled invite

`POST /documentgroup/{document_group_id}/scheduled-invite`

## Request

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

This endpoint allows API users to create a scheduled document group invite. At the moment specified by `scheduled_timestamp`, the invite is sent to recipients automatically. Both freeform invite and field invite can be sent.

**Notes**

* A paid API plan or Site License is required to create a scheduled invite.
* `scheduled_timestamp` must be a Unix timestamp (in seconds) that points to a moment in the future.
* The invite type is detected from the `invite_data` payload shape:
    * If the documents in the group do **not** contain fields, pass a [freeform invite payload](/docs/doc-group-freeform-invite/operations/post-v2-document-groups-document-group-id-free-form-invites) in `invite_data`.
    * If the documents in the group contain fields, pass a [field invite payload](/docs/doc-group-field-invite/operations/invite-to-sign-document-group) in `invite_data`.
* Each document group can have only one scheduled invite in the `active` status.

## Request body

- object
  - `invite_data` object, required: The full document group invite payload. The invite type is detected from the payload shape: * Send the same body as the [Create freeform document group invite](/docs/doc-group-freeform-invite/operations/post-v2-document-groups-document-group-id-free-form-invites) endpoint when the documents in the group do not contain fields. * Send the same body as the [Create field invite](/docs/doc-group-field-invite/operations/invite-to-sign-document-group) endpoint when the documents in the group contain fields.
  - `scheduled_timestamp` integer, required: Unix timestamp (in seconds) of the moment when the prepared invite must be sent. Must be a positive integer that points to a moment in the future.

## Response `204`

Returned when the scheduled invite passes validation and is stored with the `active` status. The response body is empty.

## Other responses

- `400`: Validation errors for the scheduled invite payload: * `scheduled_timestamp` is missing, null, not an integer, or points to a moment in the past. * `invite_data` is missing, null, of the wrong type, or empty. * The document group already has an active scheduled invite. * The document group already has an active group invite. * The user is not the document group owner. In addition, all validation errors that apply to the regular invite payload also apply to the contents of `invite_data`.

---

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