Skip to content

Add loyalty programs

POST
/api/connector/v1/loyaltyPrograms/add

Adds loyalty programs to the enterprise. Note this operation supports Portfolio Access Tokens.

MultipleLoyaltyProgramAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ChainId

Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.

string format: uuid
nullable
LoyaltyPrograms
required

Loyalty programs to be added.

Array<object>
>= 1 items <= 1000 items
LoyaltyProgramAddParameters
object
Name
required
string
>= 1 characters <= 100 characters
Code
required
string
>= 1 characters <= 50 characters
Type
Any of:
string
Allowed values: Hotel ExternalPartner SoftBrand Unknown
Subscription
Any of:
string
Allowed values: Free Paid
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
"LoyaltyPrograms": [
{
"DataClusterId": "8ddea57b-6a5c-4eec-8c4c-24467dce118e",
"Name": "Platinum Club",
"Code": "PC01",
"Type": "Hotel",
"Subscription": "Free"
}
]
}

OK

LoyaltyProgramResult
object
LoyaltyPrograms
required

Updated loyalty programs.

Array<object>
>= 1 items <= 1000 items
Loyalty program
object
Id
required

Unique identifier of the loyalty program.

string format: uuid
ChainId
required

Unique identifier of the chain.

string format: uuid
Name
required

Name of the loyalty program.

string
>= 1 characters
Code
required

Code of the loyalty program.

string
>= 1 characters
Type
Any of:
string
Allowed values: Hotel ExternalPartner SoftBrand Unknown
Subscription
Any of:
string
Allowed values: Free Paid
Cursor

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.

string format: uuid
nullable
Example
{
"LoyaltyPrograms": [
{
"Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
"Name": "Platinum Club Extra",
"Code": "PC01",
"Type": "Hotel",
"Subscription": "Free"
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable