Groups

putGroup

Adds a group to the property. Please note that the default setting for 'Route to Group Folio' will be 'No,' and the 'Reservation Folio Configuration' will be set as the default folio configuration. You can edit these settings through the user interface (UI).

post/putGroup

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/putGroup
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:group

Request body application/x-www-form-urlencoded

propertyIDstring

Property ID

namestring

Name for a group

type'group' | 'company' | 'travel_agent' | 'wholesaler'

The type of group

status'open' | 'closed'

Group status

commissionType'fixed' | 'percent'

Commission Type

sourceIDstring

Source ID for a group

address1string nullable

Address line 1 for a group

address2string nullable

Address line 2 for a group

citystring nullable

City for a group

zipstring nullable

Zip for a group

statestring nullable

State for a group

Response

200 Response

successboolean

Success

Changes

No recorded changes to this operation across all 2 revisions of this API.