API docs
Sous Chef Management API
Request access

Revoke an UberEats promotion

POST/management/promotions/revokeUberEatsPromotion

Revoke a promotion. This is terminal: there is no un-revoke, on this API or on the platform.

If Uber Eats refuses the call outright, it fails with a 502, and nothing is revoked.

The reply carries the promotion in its final state, so confirming the revoke needs no follow-up read. Revoking stops the promotion going forward; it does not reverse redemptions already made, and it refunds nothing.

Failures beyond the document-wide codes: 403 when the API key is read-only; 404 when promotionId does not exist or belongs to another organization. The two cases are indistinguishable, as everywhere else on this API.

Safe to retry: this operation changes state but is idempotent.

Request

application/json
required
  • promotionIdstring

    Required. The promotionId from createUberEatsPromotion or fetchUberEatsPromotions.

Responses

200: The promotion in its final state, normally `revoked`.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.

  • promotionUberEatsPromotion

    The promotion in its final state, normally revoked. A promotion that had already expired or completed is returned as it is. Returned so you need no follow-up read to confirm.

About Promotions

Promotions on the connected delivery platforms. Organization-scoped like every other section: the organization is the one the API key authenticates and no request field can name another.

Four operations cover the whole Uber Eats promotion lifecycle: fetchUberEatsPromotions (list), fetchUberEatsPromotion (get one, by id), createUberEatsPromotion and revokeUberEatsPromotion. There is no update and no pause on the platform, so a promotion is immutable once created.

The operations are named for the platform because the platforms differ materially: DoorDash exposes no promotion write API to integrations, and Grubhub no promotions surface at all. For both, promotion attribution arrives on the order instead (see the Orders section).

createUberEatsPromotion and revokeUberEatsPromotion are writes. A read-only API key is refused with 403.

Money is an integer in the currency's minor unit everywhere in this section: 1250 is $12.50.