SIsignnow

Send scheduled invite

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

post/document/{document_id}/scheduled-invite/send

Request

Path parameters

ID of the document whose scheduled invite is sent immediately.

Response

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

  • Field invite: an object with status.
  • Freeform invite: an array with one object that contains result, id, and callback_url.
idstring

Freeform invite only. ID of the freeform invite.

resultstring

Freeform invite only. Result of the request. Always success.

statusstring

Field invite only. Result of the request. Always success.

callback_urlstring

Freeform invite only. Callback URL of the invite. none when no callback is set.

Changes

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