PATCH /public/v1/documents/{id}/status

Servers

Path parameters

Name Type Required Description
id String Yes

Specify document ID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
notify_recipients Boolean No

Send a notification email about the status change to all recipients.

note String No

Provide “private notes” regarding the manual status change.

status Integer Yes

Possible values:

  • 11
  • 12
  • 13
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.