Create a loyalty program

Identity module

POST/loyalty-programsloyaltyPrograms.create

A travel loyalty program the caller belongs to, at most twenty (422 loyalty_program_limit). A program name appears once per kind (409). Shared with an engagement under the Travel Profile category. Creates a loyalty program. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability me.work_details.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: LoyaltyProgramCreate

loyaltyPrograms.create: LoyaltyProgramCreate
Field	Type	Required	Description
program_kind	LoyaltyProgramKind	Yes	Kind of travel loyalty program.Constraints: one of "Airline", "Hotel", "Car Rental", "Rail"
program_name	string	Yes	Program.Constraints: length 1 to 100
member_number	string	Yes	Membership number.Constraints: length 1 to 40
sort_order	integer	No	Display order.Constraints: range 0 to any

{
  "program_kind": "Airline",
  "program_name": "SkyMiles",
  "member_number": "SM-0000-TEST",
  "sort_order": 0
}

Response 201: LoyaltyProgram

loyaltyPrograms.create: LoyaltyProgram
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the loyalty program.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid)	Yes	Identifier of the person the program belongs to; always the caller.
program_kind	LoyaltyProgramKind	Yes	Kind of travel loyalty program.Constraints: one of "Airline", "Hotel", "Car Rental", "Rail"
program_name	string	Yes	Program.Constraints: length 1 to 100
member_number	string	Yes	Membership number.Constraints: length 1 to 40
sort_order	integer	Yes	Display order.Constraints: range 0 to any

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "program_kind": "Airline",
  "program_name": "SkyMiles",
  "member_number": "SM-0000-TEST",
  "sort_order": 0
}

Code samples

curl -X POST "$XOS_BASE_URL/loyalty-programs" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"program_kind":"Airline","program_name":"SkyMiles","member_number":"SM-0000-TEST","sort_order":0}'

const { data } = await xos.loyaltyPrograms.create({
    "program_kind": "Airline",
    "program_name": "SkyMiles",
    "member_number": "SM-0000-TEST",
    "sort_order": 0
  });

response = xos.loyalty_programs.create({"program_kind": "Airline", "program_name": "SkyMiles", "member_number": "SM-0000-TEST", "sort_order": 0})

xos loyalty-programs create --data '{"program_kind":"Airline","program_name":"SkyMiles","member_number":"SM-0000-TEST","sort_order":0}'