Skip to content

Update rate capacity offset pricing

POST
/api/connector/v1/rates/updateCapacityOffset

Updates capacity offset based pricing for specified rates. This operation supports Portfolio Access Tokens.

MultipleRateCapacityOffsetUpdateParameters

Parameters for updating rate capacity offsets in an enterprise.

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
EnterpriseId

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

string format: uuid
nullable
CapacityOffsetUpdates
required

A list of rate capacity offset updates to apply.

Array<object>
>= 1 items <= 50 items
RateCapacityOffsetUpdateParameters
object
RateId
required

The unique identifier of the Rate to update.

string format: uuid
NegativeOccupancyAdjustment
Decimal update value

Amount added to the price when occupancy is less than the Space Category Capacity. Use a negative value to provide a discount for under-occupancy. Set to ‘null’ if not updated.

object
Value

Value which is to be updated.

number format: double
ExtraOccupancyAdjustment
Decimal update value

Amount added to the price when the Space Category Capacity is exceeded.

object
Value

Value which is to be updated.

number format: double
Example
{
"CapacityOffsetUpdates": [
{
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
"NegativeOccupancyAdjustment": {
"Value": 10
},
"ExtraOccupancyAdjustment": {
"Value": 20
}
},
{
"RateId": "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f",
"ExtraOccupancyAdjustment": {
"Value": 15
}
}
]
}

OK

object

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