Journey Docs
Partner API ExplorerCode Pools

Revoke a code

Required scopeoffers:codes:write
DELETE
/v1/partner/code-pools/{poolRef}/codes/{code}

Revokes a single code that is still available. A code already assigned or redeemed cannot be revoked.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Path Parameters

code*string

The literal code value to revoke.

poolRef*string

Pool reference — the offer id backing the pool. Must match ^[A-Za-z0-9_-]{1,100}$.

Match^[A-Za-z0-9_-]{1,100}$

Response Body

Whether the code was revoked.

curl -X DELETE 'https://api-prd.cf.journey.com/v1/partner/code-pools/string/codes/string'
Empty