Send scheduled invite

This endpoint allows API users to send an active scheduled document group invite immediately, bypassing the originally scheduled time. After the invite is sent, the scheduled record is removed from the active status.

post/documentgroup/{document_group_id}/scheduled-invite/send

Request

Path parameters

ID of the document group whose scheduled invite is sent immediately.

Response

The scheduled invite was sent. The response depends on the invite type:

  • Field invite: id and pending_invite_link.
  • Freeform invite: a data object with id.
idstring

Field invite only. ID of the document group invite.

pending_invite_linkstring

Field invite only. Link to sign the documents if the sender is also the first signer; otherwise null.

Changes

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