Journey Docs
Partner API ExplorerLoyaltyTiers

Update a tier

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

Partial update: only the fields present in the body are changed.

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.

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.

Request Body

application/json
  1. body
name?string
Length1 <= length <= 200
qualifier?
status?string
Value in"active""draft""archived"

Response Body

The updated tier.

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

Get a tier

Previous Page

Delete a tier

Next Page