Update profile (any type)

put

https://api.cloudbeds.com/group-profile/v1/profiles/{profileId}

Update a company, group, or travel agent profile. The profile type is determined from existing data and cannot be changed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileId

int64

required

Entity ID

Body Params

string

Unique identifier for the profile

profileType

string

enum

Profile type

Allowed:

code

string

required

length between 1 and 100

Profile code (company code, group code, or IATA number for travel agents)

name

string

required

length between 1 and 255

Profile name (company name, group name, or agency name)

status

string

enum

required

Profile status

Allowed:

cellPhone

string

length ≤ 50

^[+]?[0-9\s\-().]+$

Cell phone number

phone

string

length ≤ 50

^[+]?[0-9\s\-().]+$

Primary phone number

string

length ≤ 255

Primary email address

externalCrmId

string

length ≤ 100

External CRM system reference ID

optIn

boolean

Opt-in status

optInType

string

enum

Type of opt-in

Allowed:

optInMethods

string

enum

Opt-in communication method

Allowed:

address

object

Flexible address object with country-specific fields.
The countryCode determines the expected address format.
All address fields except id and countryCode are stored as dynamic properties.
Common fields include: address1, address2, street, number, city, state, zip, etc.

useBillingAsMainAddress

boolean

Defaults to false

When true, use billing address as the main address instead of the address field

billingDetails

object

Billing details for profiles and contact persons

createdAt

date-time

Creation timestamp

updatedAt

date-time

Last update timestamp

attributes

object

Dictionary containing profile-specific data (groupProfile, companyProfile, or travelAgentProfile). Only one profile type should be present.

Headers

x-property-id

int64

Property ID

x-organization-id

int64

required

Organization ID

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Profile updated successfully

400Bad request

404Profile not found

422Unprocessable Entity