Journey Docs
Partner API ExplorerLoyaltyBenefits

Archive a benefit

Required scopepartner:loyalty:benefits:write
POST
/v1/partner/loyalty/programs/{programExternalId}/benefits/{externalId}/archive

Retires the benefit. Already-granted entitlements are unaffected; no new ones are created.

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

externalId*string

External benefit id.

programExternalId*string

External id of the loyalty program that owns the benefit.

Query Parameters

organizationId?string

External organization id (HXP UUID or WorkOS organization id). Only Journey superadmin callers may set it; for a partner credential the organization is taken from the credential and this parameter is ignored.

Response Body

The archived benefit.

curl -X POST 'https://api-prd.cf.journey.com/v1/partner/loyalty/programs/string/benefits/string/archive'
Empty

Update a benefit

Previous Page

Get the benefit audience

Next Page