Submit a document into workflow

Submit a library content item into an approval workflow within a specific teamsite. This initiates the approval process for the document identified by libraryContentId, routing it through the configured workflow steps so that designated approvers can review, approve, or reject the content before publication. An optional comment can be included to provide context to reviewers, and workflow attestation acknowledgments can be automatically confirmed if applicable.

When to use: Call this endpoint when a content author or library manager needs to move a draft document into an approval workflow prior to publishing. The response returns an array of workflow instance identifiers that were created as a result of the submission.

Glossary: teamsiteId — Identifier of the teamsite context for the request; may be 1 or a GUID. libraryContentId — Identifier of the library content item to submit into workflow. attestationsConfirmed — When true, required workflow acknowledgments are automatically marked as confirmed by the submitter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the teamsite context for the request. Accepts either the special value 1 (representing the default teamsite) or a GUID-formatted teamsite identifier.

string
required

Identifier of the library content item targeted by the operation. This must identify the content item to be submitted into the approval workflow.

Body Params

Payload containing an optional comment for reviewers and an optional flag to automatically confirm workflow attestation acknowledgments.

Request payload for submitting a library content item into an approval workflow.

string

Optional comment to include with the workflow submission, providing context or instructions for reviewers.

boolean

If specified and set to true, the required acknowledgments for workflows applicable to the current file are automatically considered as acknowledged by the submitter, and recorded upon the workflow submission. If not specified or set to false, the required acknowledgments are treated as disregarded by the submitter, and the file will be submitted to workflow without the required acknowledgments being confirmed.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json