---
title: "Update scheduled invite"
method: PUT
path: "/document/{document_id}/scheduled-invite"
---

# Update scheduled invite

`PUT /document/{document_id}/scheduled-invite`

## Request

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

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.

## Request body

- object
  - `scheduled_timestamp` integer, 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.

## Response `200`

Returned when the scheduled invite is successfully rescheduled.

- object
  - `result` string: Result of the request. Always `success`.

## Other responses

- `400`: Validation errors for the update payload: * `scheduled_timestamp` is missing, null, not an integer, or points to a moment in the past. * The document does not have an active scheduled invite. * The user is not the document owner.

---

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