Partner API ExplorerLoyaltyPrograms
Archive a loyalty program
Required scope
partner:loyalty:programs:writePOST
Retires the program. Existing member balances are preserved; no new earning occurs.
header
AuthorizationBearer <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.
externalId*stringExternal loyalty program id.
organizationId?stringExternal 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.
The archived program.
curl -X POST 'https://api-prd.cf.journey.com/v1/partner/loyalty/programs/string/archive'Empty