Manage Rates - Loyalty Auto Enrollment | SynXis Developer Portal

Beta Release - Work in progress

New API - Seeking beta customers

What is it?

The Manage Rates - Loyalty Auto Enrollment API endpoints enable you to read, create, update, and delete data for the loyalty auto enrollment of rates in SynXis CRS. You can manage the rate loyalty auto enrollment at the following levels:

Brand
Chain
Hotel

Before You Begin

You must authenticate before you can use this API. For full instructions, see Get a Token for REST APIs.
At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.

How to use

This section covers the endpoints for this API and examples of how to use them.

GET brand level loyalty auto enrollment data

This endpoint enables you to retrieve loyalty auto enrollment data for a brand level rate.

[GET] /v1/brands/{brandId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
brandId	The brandId uniquely identifies a single brand property in CRS. Example: 13098	integer	Required
code	The code to identify the brand rate. Example: RCO	string	Required

Element

Description

Type

Required?

brandId

The brandId uniquely identifies a single brand property in CRS.

Example: 13098

integer

Required

code

The code to identify the brand rate.

Example: RCO

string

Required

Response in JSON

{
  "autoEnrollment": true,
  "loyaltyProgram": "LPCODE",
  "countryAssignments": [
    {
      "code": "MN",
      "name": "Mongolia"
    }
  ]
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
autoEnrollment	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	If a loyalty program has been assigned, this is the code to identify the loyalty program. Example: LPCODE	string
countryAssignments	The array to hold country assignment information.	array
code	This is the ISO 3166-1 alpha-2 country code for the brand rate.	string
name	This is the full name of the country for the brand rate.	string

⇧ Back to top

POST brand level loyalty auto enrollment data

This endpoint enables you to create or update loyalty auto enrollment data for a brand level rate.

[POST] /v1/brands/{brandId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
brandId	The brandId uniquely identifies a single brand property in CRS. Example: 13098	integer	Required
code	The code to identify the brand rate. Example: RCO	string	Required

Element

Description

Type

Required?

brandId

The brandId uniquely identifies a single brand property in CRS.

Example: 13098

integer

Required

code

The code to identify the brand rate.

Example: RCO

string

Required

Post Body Parameters

The following table describes the parameters to include in your post request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the brand rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the brand rate.	string
autoEnrollmentRate	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	To assign a loyalty program, include the code to identify the loyalty program. Note: In order for you to assign a loyalty program, the chain for the brand must be enabled to support enrollment in multiple loyalty programs. Example: LPCODE	string

Post Body Example

The following is an example of the body for this post request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ],
  "autoEnrollmentRate": true,
  "loyaltyProgram": "LPCODE"
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.5110000+00:00",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.5110000+00:00"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top

DELETE brand level loyalty auto enrollment data

This endpoint enables you to delete loyalty auto enrollment data for a brand level rate.

[DELETE] /v1/brands/{brandId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
brandId	The brandId uniquely identifies a single brand property in CRS. Example: 13098	integer	Required
code	The code to identify the brand rate. Example: RCO	string	Required

Element

Description

Type

Required?

brandId

The brandId uniquely identifies a single brand property in CRS.

Example: 13098

integer

Required

code

The code to identify the brand rate.

Example: RCO

string

Required

Delete Body Parameters

The following table describes the parameters to include in your delete request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the brand rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the brand rate.	string

Delete Body Example

The following is an example of the body for this delete request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ]
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.511Z",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.511Z"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top

GET chain level loyalty auto enrollment data

This endpoint enables you to retrieve loyalty auto enrollment data for a chain level rate.

[GET] /v1/chains/{chainId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
chainId	The chainId uniquely identifies a single chain property in CRS. Example: 13098	integer	Required
code	The code to identify the chain rate. Example: RCO	string	Required

Element

Description

Type

Required?

chainId

The chainId uniquely identifies a single chain property in CRS.

Example: 13098

integer

Required

code

The code to identify the chain rate.

Example: RCO

string

Required

Response in JSON

{
  "autoEnrollment": true,
  "loyaltyProgram": "LPCODE",
  "countryAssignments": [
    {
      "code": "MN",
      "name": "Mongolia"
    }
  ]
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
autoEnrollment	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	If a loyalty program has been assigned, this is the code to identify the loyalty program. Example: LPCODE	string
countryAssignments	The array to hold country assignment information.	array
code	This is the ISO 3166-1 alpha-2 country code for the chain rate.	string
name	This is the full name of the country for the chain rate.	string

⇧ Back to top

POST chain level loyalty auto enrollment data

This endpoint enables you to create or update loyalty auto enrollment data for a chain level rate.

[POST] /v1/chains/{chainId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
chainId	The chainId uniquely identifies a single chain property in CRS. Example: 13098	integer	Required
code	The code to identify the chain rate. Example: RCO	string	Required

Element

Description

Type

Required?

chainId

The chainId uniquely identifies a single chain property in CRS.

Example: 13098

integer

Required

code

The code to identify the chain rate.

Example: RCO

string

Required

Post Body Parameters

The following table describes the parameters to include in your post request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the chain rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the chain rate.	string
autoEnrollmentRate	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	To assign a loyalty program, include the code to identify the loyalty program. Note: In order for you to assign a loyalty program, the chain must be enabled to support enrollment in multiple loyalty programs. Example: LPCODE	string

Post Body Example

The following is an example of the body for this post request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ],
  "autoEnrollmentRate": true,
  "loyaltyProgram": "LPCODE"
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.5110000+00:00",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.5110000+00:00"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top

DELETE chain level loyalty auto enrollment data

This endpoint enables you to delete loyalty auto enrollment data for a chain level rate.

[DELETE] /v1/chains/{chainId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
chainId	The chainId uniquely identifies a single chain property in CRS. Example: 13098	integer	Required
code	The code to identify the chain rate. Example: RCO	string	Required

Element

Description

Type

Required?

chainId

The chainId uniquely identifies a single chain property in CRS.

Example: 13098

integer

Required

code

The code to identify the chain rate.

Example: RCO

string

Required

Delete Body Parameters

The following table describes the parameters to include in your delete request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the chain rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the chain rate.	string

Delete Body Example

The following is an example of the body for this post request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ]
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.511Z",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.511Z"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top

GET hotel level loyalty auto enrollment data

This endpoint enables you to retrieve loyalty auto enrollment data for a hotel level rate.

[GET] /v1/hotels/{hotelId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
hotelId	The hotelId uniquely identifies a single hotel property in CRS. Example: 13098	integer	Required
code	The code to identify the hotel rate. Example: RCO	string	Required

Element

Description

Type

Required?

hotelId

The hotelId uniquely identifies a single hotel property in CRS.

Example: 13098

integer

Required

code

The code to identify the hotel rate.

Example: RCO

string

Required

Response in JSON

{
  "autoEnrollment": true,
  "loyaltyProgram": "LPCODE",
  "countryAssignments": [
    {
      "code": "MN",
      "name": "Mongolia"
    }
  ]
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
autoEnrollment	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	If a loyalty program has been assigned, this is the code to identify the loyalty program. Example: LPCODE	string
countryAssignments	The array to hold country assignment information.	array
code	This is the ISO 3166-1 alpha-2 country code for the hotel rate.	string
name	This is the full name of the country for the hotel rate.	string

⇧ Back to top

POST hotel level loyalty auto enrollment data

This endpoint enables you to create or update loyalty auto enrollment data for a hotel level rate.

[POST] /v1/hotels/{hotelId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
hotelId	The hotelId uniquely identifies a single hotel property in CRS. Example: 13098	integer	Required
code	The code to identify the hotel rate. Example: RCO	string	Required

Element

Description

Type

Required?

hotelId

The hotelId uniquely identifies a single hotel property in CRS.

Example: 13098

integer

Required

code

The code to identify the hotel rate.

Example: RCO

string

Required

Post Body Parameters

The following table describes the parameters to include in your post request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the hotel rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the hotel rate.	string
autoEnrollmentRate	This is true if auto enrollment is enabled for the rate. It is false if auto enrollment is not enabled for the rate.	boolean
loyaltyProgram	To assign a loyalty program, include the code to identify the loyalty program. Note: In order for you to assign a loyalty program, the chain for the hotel must be enabled to support enrollment in multiple loyalty programs. Example: LPCODE	string

Post Body Example

The following is an example of the body for this post request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ],
  "autoEnrollmentRate": true,
  "loyaltyProgram": "LPCODE"
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.5110000+00:00",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.5110000+00:00"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top

DELETE hotel level loyalty auto enrollment data

This endpoint enables you to delete loyalty auto enrollment data for a hotel level rate.

[DELETE] /v1/hotels/{hotelId}/rates/{code}/loyaltyAutoEnrollment

Path Parameters

The following table describes the elements that you must include for this operation:

Element	Description	Type	Required?
hotelId	The hotelId uniquely identifies a single hotel property in CRS. Example: 13098	integer	Required
code	The code to identify the hotel rate. Example: RCO	string	Required

Element

Description

Type

Required?

hotelId

The hotelId uniquely identifies a single hotel property in CRS.

Example: 13098

integer

Required

code

The code to identify the hotel rate.

Example: RCO

string

Required

Delete Body Parameters

The following table describes the parameters to include in your delete request:

Element	Description	Type
geoLocationList	The array to hold the identifying information about the hotel rate.	array
code	This is the ISO 3166-1 alpha-2 country code for the hotel rate.	string

Delete Body Example

The following is an example of the body for this post request:

{
  "geoLocationList": [
    {
      "code": "MN"
    }
  ]
}

Response in JSON

{
  "Warning": [
    {
      "SystemSpecificResults": {
        "Message": [
          {
            "Code": "string",
            "Value": "string"
          }
        ],
        "ShortText": "string"
      }
    }
  ],
  "timeStamp": "2025-12-10T18:25:43.511Z",
  "Success": {
    "SystemSpecificResults": {
      "Message": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ShortText": "string"
    },
    "Timestamp": "2025-12-10T18:25:43.511Z"
  }
}

Response Elements

The following table explains the elements you receive in the response:

Element	Description	Type
Warning	The array to hold any warning message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the warning.	string
Value	The value for the warning.	string
ShortText	The description of the warning about your operation.	string
timeStamp	The time stamp for when your operation resulted in the warning.	string
Success	The array to hold any success message information about your operation.	array
SystemSpecificResults	The array to hold specific message information.	array
Message	The array to hold message code, value, and description.	array
Code	The code for the success message.	string
Value	The value for the success message.	string
ShortText	The description of the success of your operation.	string
timeStamp	The time stamp for when your operation resulted in the success message.	string

⇧ Back to top