Approve the active step of an approval for a content version that is in review. For multi-step approvals, the version remains in review until all steps are approved.

post

https://example.com/_cms/v1/content/{key}/versions/{version}:approve

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

The key of the content item.

version

string

required

The version of the content item.

Body Params

Options for the approval decision. Use 'force' to bypass the normal approval flow (requires admin access).

Options for approving or rejecting a content version.

comment

string | null

An optional comment to include with the approval decision. May be required depending on the approval definition configuration.

force

boolean

Indicates if the approval should be forced, bypassing the normal approval flow. Requires 'admin' access rights.

Headers

Prefer

array of strings

Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.

Prefer

If-Match

string

If provided, the POST request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.

If-Unmodified-Since

string

If provided, the POST request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

500Internal Server Error