Update channel commission

patch

https://open-api.guesty.com/v1/channel-commissions-v2/{channelCommissionId}

Updates an existing channel commission identified by channelCommissionId (the _id from a GET response).

Omit unitTypeId for an account-level commission. Provide unitTypeId for a listing-level commission.

The body must use the same channel and source as the existing entry.

Omit commission or tax to remove them from this entry. isPreDeduct defaults to false when omitted. Listing-level commissions are used for reservations only when levelEntityType is UNIT_TYPE (see GET/PUT unit-type/{unitTypeId}/level-configurations).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

channelCommissionId

string

required

Channel commission ID (for example 5f3f7b2f5d7b9b001f6f6c9d) — the _id of an item from GET /account, GET /unit-type/{unitTypeId}, or GET /unit-type/{unitTypeId}/actual

Body Params

unitTypeId

string

Listing / unit type ID. Omit for an account-level entry; provide to create or update a listing-level entry. Must be a unit type (parent listing), not a sub-unit.

commission

object

Commission percentage (value) and which charges it applies to (of). On create, omit to save the entry without a commission. On update, omit to remove the existing commission from this entry.

tax

number

0 to 100

Tax percentage on the channel commission (0–100). On create, omit to save the entry without tax. On update, omit to remove the existing tax from this entry.

channel

string

required

length ≥ 1

Booking channel name (for example bookingCom, airbnb2, homeaway2, or manual). Must form a valid pair with source: either manual (always allowed), or an active pair from the channel-commission configurations catalog. The Guesty Open API Valid Enumerations — Channel Commission Sources guide is a product overview of sources; acceptance here is the active catalog (invalid pairs return 400). The guide’s “Set Commission” column may disagree with the catalog for a given source.

source

string

required

length ≥ 1

Booking source within the channel. Often the same as channel for direct channels; can differ for channel managers (for example channel rentalsUnited with source homeAway). Must form a valid pair with channel (see channel for the catalog rule).

isPreDeduct

boolean

Defaults to false

When true, Guesty automatically deducts the channel commission from the host payout for reservations from this source (adds a negative host channel fee on the folio). This API only honors isPreDeduct for the manual channel — for any other channel the value is ignored and stored as false. The Valid Enumerations guide may list Pre-deduct for other sources (for example expedia) as a product/UI capability; that is not controlled by this field. Defaults to false when omitted.

Responses

400

The request is invalid. Common causes: missing/invalid body fields, invalid channel/source pair, or channelCommissionId is not a valid ID.

404

No matching channel commission entry was found for the given channelCommissionId, account, channel/source, and level (unitTypeId).

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated channel commission entry