API Reference

Create a new person relationship for a profile

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

Create a relationship between this profile and a person/guest

Path Params
int64
required

Entity ID

Body Params
int64
required

ID of the person/guest to link to

string
enum
required

Type of persons

Allowed:
string
enum

Type of relationship between person and profile

boolean

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

date

Start date of the relationship (defaults to today)

date

End date of the relationship (null for indefinite)

string
enum

Role of person in the profile relationship

metadata
object

Additional relationship metadata

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