API Reference

Create a new profile (any type)

post
https://api.cloudbeds.com/group-profile/v1/profiles

Create a company, group, or travel agent profile based on the attributes provided in the request body

Body Params
string

Unique identifier for the profile

string
enum

Profile type

Allowed:
string
required
length between 1 and 100

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

string
required
length between 1 and 255

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

string
enum
required

Profile status

Allowed:
string
length ≤ 50

Cell phone number

string
length ≤ 50

Primary phone number

string
length ≤ 255

Primary email address

string
length ≤ 100

External CRM system reference ID

boolean

Opt-in status

string
enum

Type of opt-in

Allowed:
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.

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

date-time

Creation timestamp

date-time

Last update timestamp

attributes
object

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

Headers
int64

Property ID

int64
required

Organization ID

Responses

401

Unauthorized

403

Forbidden

Updated 4 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago