End promotion

End a promotion. Upstream OF endpoint is POST /api2/v2/promotions/:id/finish.

Permission Required: promotions:write

POST /v2/access/promotions/:promotionId/end

End promotion

cURL

curl --request POST \
  --url https://api.ofauth.com/v2/access/promotions/:promotionId/end \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "success": true
}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

Path Parameters

promotionId · string | null

Promotion ID

Minimum string length: 1

Response

200

application/json

Successful response

success · boolean · required