SIsignnow

Update scheduled invite

This endpoint allows API users to update the scheduled_timestamp of an active scheduled document invite. Only the timing can be changed; to change the invite payload itself, cancel the active scheduled invite and create a new one.

Notes

  • A paid API plan or Site License is required.
  • The new scheduled_timestamp must be a Unix timestamp (in seconds) that points to a moment in the future.
  • The document must have a scheduled invite in the active status.
put/document/{document_id}/scheduled-invite

Request

Path parameters

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

Request body

scheduled_timestampinteger required

New 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 is successfully rescheduled.

resultstring

Result of the request. Always success.

Changes

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