ProfilePerson

Create a new person relationship for a profile

Create a relationship between this profile and a person/guest

post/group-profile/v1/profiles/{profileId}/persons

Request

Base URL
https://api.cloudbeds.com
URL
https://api.cloudbeds.com/group-profile/v1/profiles/{profileId}/persons
Auth
HTTP bearer

Path parameters

profileIdinteger required

Entity ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Request body

personIdinteger required

ID of the person/guest to link to

personType'CONTACT' | 'GUEST' required

Type of persons

relationshipType'EMPLOYEE' | 'BOOKED_BY' | 'PART_OF_GROUP' | 'CONTACT' | 'GUEST' | 'DECISION_MAKER' | 'TRAVELER' | 'PRIMARY' | 'SECONDARY' | 'BILLING_CONTACT' | 'EMERGENCY_CONTACT'

Type of relationship between person and profile

isMainContactboolean

Whether this person is the main contact (applicable for CONTACT person type)

startDatestring date

Start date of the relationship (defaults to today)

endDatestring date

End date of the relationship (null for indefinite)

role'BOOKING_COORDINATOR' | 'ONSITE_COORDINATOR' | 'ROOMING_LIST_CONTACT' | 'ACCOUNTS_PAYABLE' | 'BILLING' | 'INVOICING' | 'ACCOUNT_MANAGER' | 'SALES_LEAD' | 'TRAVEL_AGENT_ACCOUNT_MANAGER' | 'CORPORATE_CONTACT' | 'AUTHORIZED_SIGNER' | 'EXECUTIVE_APPROVER' | 'MARKETING' | 'MAIN_POINT_OF_CONTACT' | 'ADMINISTRATIVE' | 'OTHER'

Role of person in the profile relationship

metadataobject

Additional relationship metadata

Example request

{
  "relationshipType": "PRIMARY",
  "role": "BOOKING_COORDINATOR"
}

Response

Person relationship created successfully

profileIdstring

ID of the profile entity (source)

personIdstring

ID of the person/guest (target)

personType'CONTACT' | 'GUEST'

Type of persons

relationshipType'EMPLOYEE' | 'BOOKED_BY' | 'PART_OF_GROUP' | 'CONTACT' | 'GUEST' | 'DECISION_MAKER' | 'TRAVELER' | 'PRIMARY' | 'SECONDARY' | 'BILLING_CONTACT' | 'EMERGENCY_CONTACT'

Type of relationship between person and profile

isMainContactboolean

Whether this person is the main contact (applicable for CONTACT person type)

startDatestring date

Start date of the relationship

endDatestring date

End date of the relationship (null for active)

role'BOOKING_COORDINATOR' | 'ONSITE_COORDINATOR' | 'ROOMING_LIST_CONTACT' | 'ACCOUNTS_PAYABLE' | 'BILLING' | 'INVOICING' | 'ACCOUNT_MANAGER' | 'SALES_LEAD' | 'TRAVEL_AGENT_ACCOUNT_MANAGER' | 'CORPORATE_CONTACT' | 'AUTHORIZED_SIGNER' | 'EXECUTIVE_APPROVER' | 'MARKETING' | 'MAIN_POINT_OF_CONTACT' | 'ADMINISTRATIVE' | 'OTHER'

Role of person in the profile relationship

metadataobject

Additional relationship metadata

Example response

{
  "relationshipType": "PRIMARY",
  "role": "BOOKING_COORDINATOR"
}

Changes

No recorded changes to this operation across all 1 revision of this API.