post
https://{yourinstance}.makaira.io/placement
Creates a new advertising placement (manual product list placement).
Requires authentication.
Request
POST /placement
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Content-Type | application/json |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Internal display name. |
active | boolean | Yes | Whether this placement is active. |
listType | string | Yes | The page type: search, category, or manufacturer. |
identifier | array | Yes | Array of search terms or category/manufacturer IDs that trigger this placement. |
items | array | No | Array of manually placed product items. |
enableSorting | boolean | No | When true, the placement supports sorting. |
activeTiming | boolean | No | When true, the activeFrom and activeTo scheduling fields are used. |
activeFrom | string | No | ISO 8601 start date/time for scheduled activation. |
activeTo | string | No | ISO 8601 end date/time for scheduled deactivation. |
Example Request
{
"name": "Summer Shoes Placement",
"active": true,
"listType": "search",
"identifier": ["summer shoes", "sandals"],
"items": [
{"id": "product-123", "position": 1},
{"id": "product-456", "position": 2}
]
}Response
Returns the created placement object.
Created