curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/promotions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"promotion": {
"name": "Promotions Used in 2021",
"code": "CYB-MON",
"description": "Save today with discount code XYZ at checkout.",
"usage_limit": 100,
"advertise": true,
"starts_at": "<string>",
"ends_at": "<string>",
"store_ids": [
"2"
]
}
}'
{
"data": {
"id": "58",
"type": "promotion",
"attributes": {
"description": "This is the new updated promo",
"expires_at": null,
"starts_at": null,
"name": "10% OFF",
"type": null,
"usage_limit": null,
"match_policy": "all",
"code": "RAND-10",
"advertise": false,
"path": null,
"created_at": "2022-11-08T19:35:04.723Z",
"updated_at": "2022-11-08T19:35:04.970Z",
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"promotion_category": {
"data": {
"id": "20",
"type": "promotion_category"
}
},
"promotion_rules": {
"data": [
{
"id": "19",
"type": "promotion_rule"
}
]
},
"promotion_actions": {
"data": [
{
"id": "42",
"type": "promotion_action"
}
]
},
"stores": {
"data": [
{
"id": "396",
"type": "store"
}
]
}
}
}
}
Updates a Promotion
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/promotions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"promotion": {
"name": "Promotions Used in 2021",
"code": "CYB-MON",
"description": "Save today with discount code XYZ at checkout.",
"usage_limit": 100,
"advertise": true,
"starts_at": "<string>",
"ends_at": "<string>",
"store_ids": [
"2"
]
}
}'
{
"data": {
"id": "58",
"type": "promotion",
"attributes": {
"description": "This is the new updated promo",
"expires_at": null,
"starts_at": null,
"name": "10% OFF",
"type": null,
"usage_limit": null,
"match_policy": "all",
"code": "RAND-10",
"advertise": false,
"path": null,
"created_at": "2022-11-08T19:35:04.723Z",
"updated_at": "2022-11-08T19:35:04.970Z",
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"promotion_category": {
"data": {
"id": "20",
"type": "promotion_category"
}
},
"promotion_rules": {
"data": [
{
"id": "19",
"type": "promotion_rule"
}
]
},
"promotion_actions": {
"data": [
{
"id": "42",
"type": "promotion_action"
}
]
},
"stores": {
"data": [
{
"id": "396",
"type": "store"
}
]
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Record updated
The response is of type object
.
Was this page helpful?