Journey Docs
Partner API ExplorerLoyaltyPrograms

Set the program earn multiplier

Required scopepartner:loyalty:programs:write
PUT
/v1/partner/loyalty/programs/{externalId}/earn-multiplier

Full replacement of the program-wide earn multiplier.

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 loyalty program 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
multiplier*number
Range0 <= value

Response Body

The stored multiplier.

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