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.

1 min

POST

https://api.cms.optimizely.com/v1/content/{key}/versions/{version}:approve

Path Parameters

keystringrequired
Description
The key of the content item.
versionstringrequired
Description
The version of the content item.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
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.
If-Matchstring
Description
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-Sincestring<http-date>
Description
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.
Format
http-date

Body Parameters

bodyApprovalDecisionOptions
Description
Options for the approval decision. Use 'force' to bypass the normal approval flow (requires admin access).
- commentstring
  Description
  An optional comment to include with the approval decision. May be required depending on the approval definition configuration.
  Max Length
  255
- forceboolean
  Description
  Indicates if the approval should be forced, bypassing the normal approval flow. Requires 'admin' access rights.

Responses

200OK

ContentVersion
Description
A version of a content item.
- objectContentData
  - bindingContentBinding
    Description
    Optional binding to another content item.
    - contentTypeBindingstring
      Description
      The binding definition key that controls how the source content item is linked and accessed.
    - sourcestring<uri>required
      Description
      The reference to the source content item that is being bound. This cannot be empty.
      Format
      uri
  - propertiesmap<string, PropertyData>
    Description
    Properties as they are defined by corresponding component or content type.
- object
  - keystring
    Description
    The key that identifies this content version.
  - localestring
    Description
    The locale of this content version.
  - versionstring
    Description
    The version identifier of this instance.
  - variationstring
    Description
    The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.
  - contentTypestring
    Description
    The content type of this content item.
  - displayNamestringrequired
    Description
    The display name of this content version.
    Min Length
    1
    Max Length
    255
  - publishedstring<date-time>
    Description
    Indicates a time when this content was published or should be published.
    Format
    date-time
  - expiredstring<date-time>
    Description
    Indicates a time when this content expired or should expire.
    Format
    date-time
  - statusstring
    Examples
    draft
    ready
    published
    previous
    scheduled
    rejected
    inReview
    Description
    The status of this content version.
  - delayPublishUntilstring<date-time>
    Description
    The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.
    Format
    date-time
  - routeSegmentstring
    Description
    A string that represents the segment that should be used when routing or generating routes to the current content instance. This value will always be null when content is based on a non-routable content type.
    Max Length
    255
  - simpleRoutestring
    Description
    A simple route (shortcut URL) used to access pages and experiences.
    Max Length
    253
    Pattern
    ^[^/].*$
  - lastModifiedstring<date-time>
    Format
    date-time
  - lastModifiedBystring
  - compositionCompositionNode
    Description
    The composition structure of this content version, if any. Only relevant for experiences and sections.
    - idstring
      Description
      Specifies an identifier of this composition node.
    - displayNamestring
      Description
      The display name of this composition node.
      Max Length
      255
    - nodeTypestringrequired
      Description
      The node type of this composition node.
      Min Length
      1
    - layoutTypestring
      Description
      The node layout type of this composition node
    - displaySettingsCompositionDisplaySettings
      Description
      Optional display settings for the composition node.
      - displayTemplatestringrequired
        Description
        The display template that these settings apply to.
        Min Length
        1
      - settingsmap<string, string>
        Description
        The display settings of this composition node.
    - componentContentComponent
      Description
      Specifies the associated content for this composition node, if any.
      - ContentData
        bindingContentBinding
        Description
        Optional binding to another content item.
        contentTypeBindingstring
        Description
        The binding definition key that controls how the source content item is linked and accessed.
        sourcestring<uri>required
        Description
        The reference to the source content item that is being bound. This cannot be empty.
        Format
        uri
        propertiesmap<string, PropertyData>
        Description
        Properties as they are defined by corresponding component or content type.
      - object
        referencestring<uri>
        Description
        A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.
        Format
        uri
        contentTypestring
        Description
        The key of the content type that this is an embedded instance of.
    - nodesCompositionNode[]
      Description
      The child nodes for this composition node.
      - Circular-Reference
  - mediaMediaData
    Description
    Media data attached to this content version.
    - keystring
      Description
      The key referencing the media.
      Pattern
      ^[a-f0-9]{32}\.[a-zA-Z0-9]{1,20}$

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date
Content-Locationstring
Description
Indicates the standard location for the data returned in this response.
Preference-Applied

204No Content

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

429Too Many Requests

ProblemDetails
- typestring<uri>
  Description
  A URI reference that identifies the problem type.
  Format
  uri
- titlestring
  Description
  A short, human-readable summary of the problem type.
- statusinteger<int32>
  Description
  The HTTP status code generated by the origin server for this occurrence of the problem.
  Format
  int32
  Minimum
  100
  Maximum
  599
- detailstring
  Description
  A human-readable explanation specific to this occurrence of the problem.
- instancestring<uri>
  Description
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  Format
  uri
- codestring
  Description
  Error code that identifies the problem type.
- errorsobject[]
  Description
  An array of error details with more detailed information about the problem.
  - detailstring
    Description
    A granular explanation of one specific error related to a field, header or query parameter.
  - fieldstring
    Example
    properties.header.displayName
    Description
    A string that may provide a hint to which field that was the source of the error.

Response Headers

Retry-Afternumber
Description
Indicates how long the client should wait before making a new request.

500Internal Server Error

curl

curl --request POST \
     --url https://api.cms.optimizely.com/v1/content/{key}/versions/{version}:approve \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cms.optimizely.com/v1/content/{key}/versions/{version}:approve", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cms.optimizely.com/v1/content/{key}/versions/{version}:approve")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cms.optimizely.com/v1/content/{key}/versions/{version}:approve"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "binding": {
    "contentTypeBinding": "",
    "source": ""
  },
  "properties": "",
  "key": "",
  "locale": "",
  "version": "",
  "variation": "",
  "contentType": "",
  "displayName": "",
  "published": "",
  "expired": "",
  "status": "draft",
  "delayPublishUntil": "",
  "routeSegment": "",
  "simpleRoute": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "composition": {
    "id": "",
    "displayName": "",
    "nodeType": "",
    "layoutType": "",
    "displaySettings": {
      "displayTemplate": "",
      "settings": ""
    },
    "component": {},
    "nodes": [
      {
        "": ""
      }
    ]
  },
  "media": {
    "key": ""
  }
}

204

// No Content

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

412

// Precondition Failed

429

// Too Many Requests
{
  "type": "",
  "title": "",
  "status": "",
  "detail": "",
  "instance": "",
  "code": "",
  "errors": [
    {
      "detail": "",
      "field": "properties.header.displayName"
    }
  ]
}

500

// Internal Server Error