POST /structured-contents

1 min

POST

https://api.cmp.optimizely.com/v3/structured-contents

Experimental Creates a structured content.

Body Parameters

bodyLibraryStructuredContentCreateRequestrequired

Examples

Plain fields:

{
  "title": "My Industry Page",
  "content_body": {
    "content_type_guid": "5d7f910551b00a722e0418830cee6633",
    "root_content": true,
    "title": "My Industry Page",
    "fields": {
      "title": [
        {
          "locale": "en_US",
          "field_values": [
            {
              "text_value": "My Industry Page"
            }
          ]
        }
      ]
    }
  }
}

Reference field with new embedded items:

{
  "title": "My Industry Page",
  "content_body": {
    "content_type_guid": "5d7f910551b00a722e0418830cee6633",
    "root_content": true,
    "title": "My Industry Page",
    "fields": {
      "has_embedded": true,
      "painGains": [
        {
          "locale": "en_US",
          "field_values": [
            {
              "content_details": {
                "content_type_guid": "8a1c0e2f4b6d47e0a1b2c3d4e5f60718",
                "root_content": false,
                "title": "Faster onboarding",
                "fields": {
                  "title": [
                    {
                      "locale": "en_US",
                      "field_values": [
                        {
                          "text_value": "Faster onboarding"
                        }
                      ]
                    }
                  ],
                  "description": [
                    {
                      "locale": "en_US",
                      "field_values": [
                        {
                          "rich_text_value": "<p>Cut ramp time in half.</p>"
                        }
                      ]
                    }
                  ]
                }
              }
            },
            {
              "content_details": {
                "content_type_guid": "8a1c0e2f4b6d47e0a1b2c3d4e5f60718",
                "root_content": false,
                "title": "Lower total cost",
                "fields": {
                  "title": [
                    {
                      "locale": "en_US",
                      "field_values": [
                        {
                          "text_value": "Lower total cost"
                        }
                      ]
                    }
                  ],
                  "description": [
                    {
                      "locale": "en_US",
                      "field_values": [
                        {
                          "rich_text_value": "<p>Consolidate tooling spend.</p>"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

Description

Payload to create the structured content

titlestring
Description
Title of the structured content asset
folder_idstring
Example
6bb8db20a5b611ebae319b7c541b1a5a
Description
ID of the folder containing the structured content in the library
content_bodyobjectrequired
Description
The structured content body
- content_type_guidstringrequired
  Description
  The guid of the content's content type
- fieldsStructuredContentBody
  Description
  The fields of structured content
  - has_embeddedboolean
    Description
    Set to true when embedding new content via reference fields (using content_details). Required to create embedded content.
- root_contentbooleanrequired
  Description
  Set to false for content embedded via a reference field; true for root content.
- titlestring
  Example
  Some webpage
  Description
  Title of the structured content
- expiredboolean
  Description
  Expired status of the content
- expiry_datetimestring<date-time>
  Description
  Date and time on which the content will expire, in ISO 8601 UTC format
  Format
  date-time
- sourcestring
  Description
  Source of the content
- source_idstring
  Description
  Source id of the content
- source_metadatastring
  Description
  Source metadata of the content

Responses

200Structured content created

LibraryStructuredContent
- idstringrequired
  Example
  a24b834427a043ab8caed1ded4606f7d
  Description
  Unique identifier of the structured content
- titlestringrequired
  Example
  Some webpage
  Description
  Title of the structured content
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the structured content was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the structured content, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- folder_idstringrequired
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the structured content in the library
- file_locationstringrequired
  Example
  /all files/
  Description
  Location of the folder containing the structured content in the library
- is_archivedbooleanrequired
  Example
  true
  Description
  Whether the structured content is archived or not
- owner_organization_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of owner organization of the structured content
- content_bodyContentDetailsModel
  - titlestringrequired
    Description
    Title of the content
  - primary_localestring
    Example
    en_US
    Description
    The primary locale of the content
  - expiredboolean
    Description
    Expired status of the content
  - sourcestring
    Description
    Source of the content
  - root_contentbooleanrequired
    Description
    This is true when the content is not embedded in another content through a content type reference field
  - template_guidstring
    Description
    Template GUID of the content
  - expiry_datetimestring<date-time>
    Description
    Date and time on which the content will expire, in ISO 8601 UTC format
    Format
    date-time
  - source_idstring
    Description
    Source ID of the content
  - source_metadatastring
    Description
    Source metadata of the content
  - latest_fields_versionContentFieldsVersionDetailsrequired
    - fieldsmap<string, LocalizedFieldValues[]>required
      Description
      List of fields
    - validationContentFieldsVersionValidation
      - fieldsmap<string, object>
        Description
        Validation for the fields
    - created_bystringrequired
      Description
      Unique identifier of the user who created the version
    - source_idstring
      Description
      Source ID of the version
    - source_metadatastring
      Description
      Source metadata of the version
    - created_atstring<date-time>required
      Description
      Date and time on which the version was created, in ISO 8601 UTC format
      Format
      date-time
    - version_guidstringrequired
      Description
      Unique identifier of the version
    - content_hashstringrequired
      Description
      Content hash of the version
  - content_guidstringrequired
    Description
    Unique identifier of the content
  - created_bystringrequired
    Description
    Unique identifier of the user who created the content
  - updated_bystringrequired
    Description
    Unique identifier of the user who last updated the content
  - created_atstring<date-time>required
    Description
    Date and time on which the content was created, in ISO 8601 UTC format
    Format
    date-time
  - updated_atstring<date-time>required
    Description
    Date and time on which the content was last updated, in ISO 8601 UTC format
    Format
    date-time
  - content_type_guidstringrequired
    Description
    Unique identifier of the content type
  - content_type_namestringrequired
    Description
    Name of the content type
  - content_typeVersionedContentTypeModel
    - namestringrequired
      Description
      Name of the content type
    - descriptionstring
      Description
      Description of the content type
    - componentbooleanrequired
      Description
      Indicates whether the content type is a component
    - disabledboolean
      Description
      Disabled status of the content type
    - sourcestring
      Description
      Source of the content type
    - versionSCContentTypeVersionrequired
      - BaseContentTypeVersionModel
        latestbooleanrequired
        Description
        Indicates whether the version is the latest
        version_guidstringrequired
        Description
        Unique identifier of the version
        created_bystringrequired
        Description
        Unique identifier of the user who created the version
        created_atstring<date-time>required
        Description
        Date and time on which the version was created, in ISO 8601 UTC format
        Format
        date-time
        expected_localesstring[]required
        Description
        Expected locales of the version
        linksobjectrequired
        Description
        Meta links
        selfstring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414/versions/31a6d15b09c54a04935203eb958ae058
        Description
        URL of the content type version
        content_typestring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414
        Description
        URL of the content type
      - object
        field_definitionsNumberFieldDefinition[]required
        coreCoreFieldDefrequired
        Max depth limit reached
        min_valuenumber
        Description
        Minimum value of the field
        max_valuenumber
        Description
        Maximum value of the field
        default_valuesnumber[]
        Description
        Default values of the field
    - thumbnail_guidstring
      Description
      Thumbnail GUID of the content type
    - content_type_guidstringrequired
      Description
      Unique identifier of the content type
    - created_bystringrequired
      Description
      Unique identifier of the user who created the content type
    - updated_bystringrequired
      Description
      Unique identifier of the user who last updated the content type
    - created_atstring<date-time>required
      Description
      Date and time on which the content type was created, in ISO 8601 UTC format
      Format
      date-time
    - updated_atstring<date-time>required
      Description
      Date and time on which the content type was last updated, in ISO 8601 UTC format
      Format
      date-time
    - source_idstring
      Description
      Source of the content type
    - source_metadatastring
      Description
      Source metadata of the content type
    - linksobjectrequired
      Description
      Meta links
      - selfstring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b
        Description
        URL of the content type
      - versionsstring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b/versions
        Description
        URL of the content type versions
  - linksobjectrequired
    Description
    Meta links
    - selfstring
      Example
      https://api.cmp.optimizely.com/v3/structured-content/contents/a24b834428a043ab8caed1ded4606f7d
      Description
      URL of the content
    - definitionstring
      Example
      https://api.cmp.optimizely.com/v3/structured-content/content-types/5291e00b990a49f1857adc024fd26620/versions/a8b48d529701452aa56a4e752e1b0ffc
      Description
      URL of the content definition
- labelsResourceLabelResponse[]required
  Description
  Labels associated with the structured content
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/structured-contents/a24b834427a043ab8caed1ded4606f7d
    Description
    URL of the structured content

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/structured-contents \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "content_body": {
     "content_type_guid": "",
     "root_content": ""
     }
     }'

javascript

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

var raw = JSON.stringify({
   "content_body": {
      "content_type_guid": "",
      "root_content": ""
   }
});

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

fetch("https://api.cmp.optimizely.com/v3/structured-contents", 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.cmp.optimizely.com/v3/structured-contents")

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"
request.body = JSON.dump({
   "content_body": {
      "content_type_guid": "",
      "root_content": ""
   }
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/structured-contents"

payload = json.dumps({
   "content_body": {
      "content_type_guid": "",
      "root_content": ""
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Structured content created
{
  "id": "a24b834427a043ab8caed1ded4606f7d",
  "title": "Some webpage",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
  "file_location": "/all files/",
  "is_archived": true,
  "owner_organization_id": "5108c3a9becac35915111191",
  "content_body": {
    "title": "",
    "primary_locale": "en_US",
    "expired": false,
    "source": "",
    "root_content": false,
    "template_guid": "",
    "expiry_datetime": "",
    "source_id": "",
    "source_metadata": "",
    "latest_fields_version": {
      "fields": "",
      "validation": {
        "fields": ""
      },
      "created_by": "",
      "source_id": "",
      "source_metadata": "",
      "created_at": "",
      "version_guid": "",
      "content_hash": ""
    },
    "content_guid": "",
    "created_by": "",
    "updated_by": "",
    "created_at": "",
    "updated_at": "",
    "content_type_guid": "",
    "content_type_name": "",
    "content_type": {
      "name": "",
      "description": "",
      "component": false,
      "disabled": false,
      "source": "",
      "version": {},
      "thumbnail_guid": "",
      "content_type_guid": "",
      "created_by": "",
      "updated_by": "",
      "created_at": "",
      "updated_at": "",
      "source_id": "",
      "source_metadata": "",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b",
        "versions": "https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b/versions"
      }
    },
    "links": {
      "self": "https://api.cmp.optimizely.com/v3/structured-content/contents/a24b834428a043ab8caed1ded4606f7d",
      "definition": "https://api.cmp.optimizely.com/v3/structured-content/content-types/5291e00b990a49f1857adc024fd26620/versions/a8b48d529701452aa56a4e752e1b0ffc"
    }
  },
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/structured-contents/a24b834427a043ab8caed1ded4606f7d"
  }
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}