Create or update a document in a specific project

Create or update a document in a specific project.

The document will be created with state unpublished. To make changes available on the live website, it's necessary to merge the project.

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

specifies the project content is added to

string
required

Path of a document. This is the absolute path to the document, including the document name. Folders appearing in this path need to preexist

Body Params

A document is a content item in the Content repository. See Content types and General concepts

string
required

the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content

fields
array of objects
required

fields of this document. A document field represents an attribute of the document, as specified in the document's content type. See Content type fields and General concepts

fields*
string
required

identifying name of this document. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path.

string
required

name of this document. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the document is new, b. the document only exists in the project specified in this operation

string

document locale

string
required

absolute path of this document in the content repository

Headers
string

Resource's version, as obtained when GETting the resource. The first time a resource is created, a empty value is expected (omit the header). Must be used in any subsequent update requests of this resource

Responses

403

Forbidden

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

© Bloomreach, Inc. All rights reserved.