FOfourthwall
Promotions

Update a promotion

Changed on

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Updates an existing promotion's configuration. Only provided fields are updated; omitted fields remain unchanged. Status changes (activate/deactivate) are part of the same update call.

put/open-api/v1.0/promotions/{promotionId}

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/promotions/{promotionId}
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: promotions_write
    • or HTTP basic

Path parameters

promotionIdstring required

Request body

status'LIVE' | 'ENDED'

Example request

{
  "requirements": {
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  }
}

Response

OK

OR
OR
OR
OR

Example response

{
  "discount": {
    "money": {
      "value": 10,
      "currency": "USD"
    }
  },
  "requirements": {
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  }
}

Changes

  • d02dd5a76313Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status