Create a campaign
post
https://api.flactrum.com/v1/campaigns
| Required scope | campaigns.write |
| Success status | 201 |
| Returns | One Campaign object |
Request body
| Field | Type | Description |
|---|---|---|
| name * | string | — |
| description | string|null | — |
| discount_type * | string | — |
| discount_value * | number | Percentage discounts cannot exceed 100. |
| starts_at * | string | — |
| ends_at * | string | Must be after starts_at. |
| is_active | boolean | — |
| priority | integer | — |
| branch_ids | array | Omit or send empty for a brand-wide campaign. |
| product_ids | array | — |
| category_ids | array | Leave both target lists empty to cover the whole menu. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | — |
| description | string|null | — |
| discount_type | string | — |
| discount_value | number | — |
| discount_label | string | Human-readable summary, e.g. "%20 indirim". |
| starts_at | string | — |
| ends_at | string | — |
| is_active | boolean | — |
| priority | integer | When several campaigns hit one product, the highest priority wins. Campaigns never stack. |
| is_running | boolean | — |
| status | string | — |
| branch_ids | array | Empty means the campaign is brand-wide. |
| product_ids | array | — |
| category_ids | array | — |
| targets_whole_menu | boolean | True when no product or category was targeted. |
Examples
No recorded example yet.