Journey Docs
Partner API ExplorerLoyaltyTiers

Grant a tier to a member

Required scopepartner:loyalty:programs:write
POST
/v1/partner/loyalty/programs/{programExternalId}/tiers/{tierExternalId}/grants

Manually places a member in this tier, bypassing the qualifier — for example for a comped VIP.

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

programExternalId*string

External id of the loyalty program that owns the tier ladder.

tierExternalId*string

External tier id.

Request Body

application/json
  1. body
memberExternalId*string

The member's opaque external id — never an internal integer id.

Length1 <= length
note?string

Why this member qualified. Recorded as grant provenance (audit).

Lengthlength <= 2000
organizationId?string

External org id — global/superadmin callers only.

validThrough?string

Calendar end of the conferred term. Omitted = open-ended.

Response Body

The created grant.

curl -X POST 'https://api-prd.cf.journey.com/v1/partner/loyalty/programs/string/tiers/string/grants' \  -H 'Content-Type: application/json' \  -d '{  "memberExternalId": "string"}'
Empty