Journey Docs
Partner API ExplorerLoyaltyTiers

Create a tier

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

Adds a tier to the program. Omitting a qualifier leaves the tier unconfigured, and it defaults to draft status.

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.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 200
organizationId?string

External org id — global/superadmin callers only.

qualifier?

Omitted = an unconfigured tier ({ type: 'none' }).

status?string

Defaults to draft; tiers go live explicitly.

Value in"active""draft""archived"

Response Body

The newly created tier.

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

List tiers

Previous Page

Get a tier

Next Page