Loyalty programs
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all loyalty programs of the enterprise, optionally filtered by specific loyalty program identifiers, activity states, or other filter parameters. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/loyaltyPrograms/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
LoyaltyProgramIds
array of string
optional, max 1000 items
CreatedUtc
optional, max length 3 months
UpdatedUtc
optional, max length 3 months
ActivityStates
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned.
LoyaltyPrograms
required
The loyalty programs of the enterprise.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Id
string
required
Unique identifier of the loyalty program.
ChainId
string
optional
Unique identifier of the chain.
Name
string
required
Name of the loyalty program.
Code
string
required
Code of the loyalty program.
Type
string
required
Subscription
string
required
Hotel
ExternalPartner
SoftBrand
Free
Paid
[PlatformAddress]/api/connector/v1/loyaltyPrograms/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
LoyaltyPrograms
required, max 1000 items
Loyalty programs to be added.
Name
string
required
Name of the loyalty program.
Code
string
required
Code of the loyalty program.
Type
required
Type of the loyalty program.
Subscription
required
Subscription of the loyalty program.
LoyaltyPrograms
required
Added loyalty programs.
[PlatformAddress]/api/connector/v1/loyaltyPrograms/update
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
LoyaltyProgramUpdates
required, max 1000 items
Loyalty programs to be updated.
LoyaltyProgramId
string
required
Unique identifier of the loyalty program.
Name
optional
Name of the loyalty program (or null
if the name should not be updated).
Type
optional
Type of the loyalty program, (or null
if the type should not be updated).
Subscription
optional
Subscription of the loyalty program, (or null
if the subscription should not be updated).
Value
required
Type of the loyalty program.
Value
required
Subscription of the loyalty program.
LoyaltyPrograms
required
Updated loyalty programs.
Deletes loyalty programs. Note that a loyalty program containing active memberships cannot be deleted.
[PlatformAddress]/api/connector/v1/loyaltyPrograms/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
LoyaltyProgramIds
array of string
required, max 1000 items
Unique identifier of the loyalty programs to be deleted.
Unique identifiers of .
Interval of creation date and time.
Interval of last update date and time.
array of string
array of
Adds loyalty programs to the enterprise. Note this operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
array of
string
string
array of
Updates information about the specified loyalty programs. Note this operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
array of
string
string
array of