Manage Rates - Company Profile Assignment

How to use

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

GET company profile assignments and default descriptions for a brand rate

This endpoint enables you to view which company profiles are assigned to a brand level rate and view the default descriptions of those assignments.

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

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "rateName": "Standard RAC Rate",
  "rateCode": "RAC",
  "rateStatus": "Active",
  "CompanyProfileList": [
    {
      "CompanyProfile": {
        "code": "Rt101",
        "Level": "Chain",
        "name": "Company Profile",
        "DefaultDescription": "RateAssignmentDefaultDescription",
        "Hotel": {
          "id": 10000
        },
        "Chain": {
          "id": 10000
        }
      }
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignments and default descriptions for a brand rate

This endpoint enables you to assign chain level company profiles to a brand level rate. With this endpoint, you can also create default descriptions for those assignments.

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

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

PUT company profile assignment default descriptions for a brand rate

This endpoint enables you to update the default descriptions for existing company profile assignments for a brand level rate.

You cannot update the company profile assignment itself with this PUT. To update the company profile assignment, you would delete the assignment with the DELETE endpoint and then create a new assignment with the POST endpoint.

[PUT] /v1/brands/{brandId}/rates/{code}/companyProfiles

Path Parameters

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

Put Body Parameters

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

Put Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignments and default descriptions for a brand rate

This endpoint enables you to delete (unassign) the assignment of chain level company profiles to brand level rates. With this endpoint, you can also delete the default descriptions for those assignments.

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

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

GET company profile assignments and default descriptions for a chain rate

This endpoint enables you to view which company profiles are assigned to a chain level rate and view the default descriptions of those assignments.

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

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "rateName": "Standard RAC Rate",
  "rateCode": "RAC",
  "rateStatus": "Active",
  "CompanyProfileList": [
    {
      "CompanyProfile": {
        "code": "Rt101",
        "Level": "Chain",
        "name": "Company Profile",
        "DefaultDescription": "RateAssignmentDefaultDescription",
        "Hotel": {
          "id": 10000
        },
        "Chain": {
          "id": 10000
        }
      }
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignments and default descriptions for a chain rate

This endpoint enables you to assign chain level company profiles to a chain level rate. With this endpoint, you can also create default descriptions for those assignments.

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

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

PUT company profile assignment default descriptions for a chain rate

This endpoint enables you to update the default descriptions for existing company profile assignments for a chain level rate.

You cannot update the company profile assignment itself with this PUT. To update the company profile assignment, you would delete the assignment with the DELETE endpoint and then create a new assignment with the POST endpoint.

[PUT] /v1/chains/{chainId}/rates/{code}/companyProfiles

Path Parameters

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

Put Body Parameters

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

Put Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignments and default descriptions for a chain rate

This endpoint enables you to delete (unassign) the assignment of chain level company profiles to chain level rates. With this endpoint, you can also delete the default descriptions for those assignments.

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

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

GET company profile assignments and default descriptions for a hotel rate

This endpoint enables you to view which company profiles are assigned to a hotel level rate and view the default descriptions of those assignments.

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

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "rateName": "Standard RAC Rate",
  "rateCode": "RAC",
  "rateStatus": "Active",
  "CompanyProfileList": [
    {
      "CompanyProfile": {
        "code": "Rt101",
        "Level": "Chain",
        "name": "Company Profile",
        "DefaultDescription": "RateAssignmentDefaultDescription",
        "Hotel": {
          "id": 10000
        },
        "Chain": {
          "id": 10000
        }
      }
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignments and default descriptions for a hotel rate

This endpoint enables you to assign chain or hotel level company profiles to a hotel level rate. With this endpoint, you can also create default descriptions for those assignments.

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

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

PUT company profile assignment default descriptions for a hotel rate

This endpoint enables you to update the default descriptions for existing company profile assignments for a hotel level rate.

You cannot update the company profile assignment itself with this PUT. To update the company profile assignment, you would delete the assignment with the DELETE endpoint and then create a new assignment with the POST endpoint.

[PUT] /v1/hotels/{hotelId}/rates/{code}/companyProfiles

Path Parameters

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

Put Body Parameters

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

Put Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignments and default descriptions for a hotel rate

This endpoint enables you to delete (unassign) the assignment of chain or hotel level company profiles to hotel level rates. With this endpoint, you can also delete the default descriptions for those assignments.

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

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "code": "OurCode",
      "DefaultDescription": "RateAssignmentDefaultDescription"
    }
  ],
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

POST company profile assignments for a group rate

This endpoint enables you to assign company profiles to a group level rate. You cannot create default descriptions at the group level.

[POST] /v1/hotels/{hotelId}/groupRates/{code}/companyProfiles

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "Code": "OurCode",
  "Level": "Chain",
  "ChainId": 10000
}		

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignments for a group level rate

This endpoint enables you to delete (unassign) the assignment of company profiles to group level rates. You cannot delete default descriptions at the group level.

[DELETE] /v1/hotels/{hotelId}/groupRates/{code}/companyProfiles

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "Code": "OurCode",
  "Level": "Chain"
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

GET company profile assignment seasonal descriptions for a brand rate

This endpoint enables you to view which company profile assignment seasonal descriptions are associated with a brand level rate.

[GET] /v1/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "RateName": "Standard RAC Rate",
  "RateCode": "RAC",
  "RateStatus": "Active",
  "CompanyProfiles": [
    {
      "Code": "Rt101",
      "Level": "Chain",
      "Name": "Company",
      "DefaultDescription": "RateAssignmentDefaultDescription",
      "Hotel": {
        "id": 10000
      },
      "Chain": {
        "id": 10000
      },
      "RateSeasonalDescriptions": [
        {
          "Description": "RateAssignmentSeasonalDescription",
          "StartDate": "2025-03-09",
          "EndDate": "2025-10-10"
        }
      ]
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignment seasonal descriptions for a brand rate

This endpoint enables you to create a seasonal description for a company profile assignment for a brand level rate.

[POST] /v1/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignment seasonal descriptions for a brand rate

This endpoint enables you to delete a seasonal description for a company profile assignment for a brand level rate.

[DELETE] /v1/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

GET company profile assignment seasonal descriptions for a chain rate

This endpoint enables you to view which company profile assignment seasonal descriptions are associated with a chain level rate.

[GET] /v1/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "RateName": "Standard RAC Rate",
  "RateCode": "RAC",
  "RateStatus": "Active",
  "CompanyProfiles": [
    {
      "Code": "Rt101",
      "Level": "Chain",
      "Name": "Company",
      "DefaultDescription": "RateAssignmentDefaultDescription",
      "Hotel": {
        "id": 10000
      },
      "Chain": {
        "id": 10000
      },
      "RateSeasonalDescriptions": [
        {
          "Description": "RateAssignmentSeasonalDescription",
          "StartDate": "2025-03-09",
          "EndDate": "2025-10-10"
        }
      ]
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignment seasonal descriptions for a chain rate

This endpoint enables you to create a seasonal description for a company profile assignment for a chain level rate.

[POST] /v1/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignment seasonal descriptions for a chain rate

This endpoint enables you to delete a seasonal description for a company profile assignment for a chain level rate.

[DELETE] /v1/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

GET company profile assignment seasonal descriptions for a hotel rate

This endpoint enables you to view which company profile assignment seasonal descriptions are associated with a hotel level rate.

[GET] /v1/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "RateName": "Standard RAC Rate",
  "RateCode": "RAC",
  "RateStatus": "Active",
  "CompanyProfiles": [
    {
      "Code": "Rt101",
      "Level": "Chain",
      "Name": "Company",
      "DefaultDescription": "RateAssignmentDefaultDescription",
      "Hotel": {
        "id": 10000
      },
      "Chain": {
        "id": 10000
      },
      "RateSeasonalDescriptions": [
        {
          "Description": "RateAssignmentSeasonalDescription",
          "StartDate": "2025-03-09",
          "EndDate": "2025-10-10"
        }
      ]
    }
  ],
  "HotelList": [
    {
      "id": 10000,
      "name": "Hotel",
      "code": "ourHOTEL"
    }
  ],
  "ChainList": [
    {
      "id": 10000,
      "name": "Chain",
      "code": "ourCHAIN"
    }
  ],
  "Paging": {
    "size": 50,
    "start": 0,
    "total": 146
  }
}

Response Elements

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

⇧ Back to top

POST company profile assignment seasonal descriptions for a hotel rate

This endpoint enables you to create a seasonal description for a company profile assignment for a hotel level rate.

[POST] /v1/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Post Body Parameters

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

Post Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top

DELETE company profile assignment seasonal descriptions for a hotel rate

This endpoint enables you to delete a seasonal description for a company profile assignment for a hotel level rate.

[DELETE] /v1/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptions

Path Parameters

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

Delete Body Parameters

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

Delete Body Example

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

{
  "CompanyProfileList": [
    {
      "Code": "OurCode",
      "Level": "Chain",
      "StartDate": "2025-03-09",
      "EndDate": "2025-09-10",
      "Description": "Rate Seasonal Description"
    }
  ]
}

Response in JSON

{
  "Code": "RequestSuccessful"
}

Response Elements

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

⇧ Back to top