post

/content/placements

Creates a Placement.

Required Fields

  • widget_uuid
  • template_file

Template Files

To view the list of values accepted by the template_file property, including custom templates, see Placements.

Authorization

apiKey - X-Auth-Token

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
widget_uuid
string

A widget identifier.

required
template_file
string

The template file that you would like to target.

required
entity_id
string

The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not support entity_id.

sort_order
integer

The sort order to control the position of a content widget in a region.

region
string

The name of the region in which to insert content widgets.

status
string

Sets the placement as either inactive or active.

2 validations

Responses

1 Example
Schema
object
data
object
meta
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
store_hash
X-Auth-Token