SIsignnow

Create scheduled invite

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 in invite_data.
    • If the documents in the group contain fields, pass a field invite payload in invite_data.
  • Each document group can have only one scheduled invite in the active status.
post/documentgroup/{document_group_id}/scheduled-invite

Request

Path parameters

ID of the document group for which the scheduled invite is created.

Request body

invite_dataobject 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 endpoint when the documents in the group do not contain fields.
  • Send the same body as the Create field invite endpoint when the documents in the group contain fields.
scheduled_timestampinteger 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.

Example request

{
  "scheduled_timestamp": 1820000000
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.