Create
curl --request POST \
--url https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"title": {
"value": "MRS",
"from": "pms"
},
"gender": {
"value": "M",
"from": "system"
},
"pmsId": {
"value": {
"id": "139569",
"pms": "protelio"
},
"from": "pms"
},
"lastname": {
"value": "Dupont",
"from": "pms"
},
"firstname": {
"value": "Martin",
"from": "pms"
},
"middlename": {
"value": "Fitzgerlad",
"from": "guest"
},
"birthdate": {
"value": {
"birthdate": "1987-02-20"
},
"from": "guest"
},
"birthplace": {
"value": {
"city": "La Rochelle",
"zipcode": "17000",
"country": "FR"
},
"from": "pms"
},
"company": {
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"from": "guest"
},
"loyalty": {
"value": {
"program": "hotelrewards",
"id": "123456789",
"status": "gold",
"points": 107
},
"from": "guest"
},
"optedOut": {
"marketing": {
"value": true,
"from": "guest"
},
"prestay": {
"value": false,
"from": "agent"
}
},
"addresses": [
{
"value": {
"street": "12 avenue de l'Europe",
"zipcode": "31520",
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"country": "FR"
},
"from": "guest"
},
{
"value": {
"street": "21 rue de Rocroy",
"zipcode": "75000",
"city": "Paris",
"state": "Ile-de-France",
"country": "FR"
},
"from": "agent"
}
],
"emails": [
{
"value": {
"email": "martin.dupont@example.com"
},
"from": "guest"
}
],
"nationalities": [
{
"value": "FR",
"from": "guest"
},
{
"value": "ES",
"from": "guest"
}
],
"languages": [
{
"value": "fr",
"from": "guest"
},
{
"value": "es",
"from": "guest"
}
],
"customFields": {
"guest_status": {
"value": "DIAMOND",
"from": "guest"
},
"option": {
"value": "2022-02-19",
"from": "guest"
},
"lunch": {
"value": true,
"from": "guest"
},
"spa_revenus": {
"value": 888,
"from": "guest"
}
},
"socials": {
"avatar": {
"value": "https://www.example.com/avatars/martin-dupont.png",
"from": "agent"
},
"website": {
"value": "https://www.example.com",
"from": "system"
},
"facebook": {
"value": "https://www.facebook.com/example",
"from": "agent"
},
"linkedin": {
"value": {
"url": "https://www.linkedin.com/in/example"
},
"from": "system"
},
"twitter": {
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"from": "system"
}
},
"documents": {
"identity_card": {
"value": {
"id": "123456789"
},
"from": "pms"
},
"passport": {
"value": {
"id": "123456789"
},
"from": "pms"
},
"driving_licence": {
"value": {
"id": "123456789"
},
"from": "pms"
}
}
}
EOFconst url = 'https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: {value: 'MRS', from: 'pms'},
gender: {value: 'M', from: 'system'},
pmsId: {value: {id: '139569', pms: 'protelio'}, from: 'pms'},
lastname: {value: 'Dupont', from: 'pms'},
firstname: {value: 'Martin', from: 'pms'},
middlename: {value: 'Fitzgerlad', from: 'guest'},
birthdate: {value: {birthdate: '1987-02-20'}, from: 'guest'},
birthplace: {value: {city: 'La Rochelle', zipcode: '17000', country: 'FR'}, from: 'pms'},
company: {value: {title: 'Web developer', company: 'D-EDGE CRM'}, from: 'guest'},
loyalty: {
value: {program: 'hotelrewards', id: '123456789', status: 'gold', points: 107},
from: 'guest'
},
optedOut: {
marketing: {value: true, from: 'guest'},
prestay: {value: false, from: 'agent'}
},
addresses: [
{
value: {
street: '12 avenue de l\'Europe',
zipcode: '31520',
city: 'Ramonville Saint-Agne',
state: 'Occitanie',
country: 'FR'
},
from: 'guest'
},
{
value: {
street: '21 rue de Rocroy',
zipcode: '75000',
city: 'Paris',
state: 'Ile-de-France',
country: 'FR'
},
from: 'agent'
}
],
emails: [{value: {email: 'martin.dupont@example.com'}, from: 'guest'}],
nationalities: [{value: 'FR', from: 'guest'}, {value: 'ES', from: 'guest'}],
languages: [{value: 'fr', from: 'guest'}, {value: 'es', from: 'guest'}],
customFields: {
guest_status: {value: 'DIAMOND', from: 'guest'},
option: {value: '2022-02-19', from: 'guest'},
lunch: {value: true, from: 'guest'},
spa_revenus: {value: 888, from: 'guest'}
},
socials: {
avatar: {value: 'https://www.example.com/avatars/martin-dupont.png', from: 'agent'},
website: {value: 'https://www.example.com', from: 'system'},
facebook: {value: 'https://www.facebook.com/example', from: 'agent'},
linkedin: {value: {url: 'https://www.linkedin.com/in/example'}, from: 'system'},
twitter: {value: {url: 'https://twitter.com/example', followers: 500}, from: 'system'}
},
documents: {
identity_card: {value: {id: '123456789'}, from: 'pms'},
passport: {value: {id: '123456789'}, from: 'pms'},
driving_licence: {value: {id: '123456789'}, from: 'pms'}
}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create"
payload = {
"title": {
"value": "MRS",
"from": "pms"
},
"gender": {
"value": "M",
"from": "system"
},
"pmsId": {
"value": {
"id": "139569",
"pms": "protelio"
},
"from": "pms"
},
"lastname": {
"value": "Dupont",
"from": "pms"
},
"firstname": {
"value": "Martin",
"from": "pms"
},
"middlename": {
"value": "Fitzgerlad",
"from": "guest"
},
"birthdate": {
"value": { "birthdate": "1987-02-20" },
"from": "guest"
},
"birthplace": {
"value": {
"city": "La Rochelle",
"zipcode": "17000",
"country": "FR"
},
"from": "pms"
},
"company": {
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"from": "guest"
},
"loyalty": {
"value": {
"program": "hotelrewards",
"id": "123456789",
"status": "gold",
"points": 107
},
"from": "guest"
},
"optedOut": {
"marketing": {
"value": True,
"from": "guest"
},
"prestay": {
"value": False,
"from": "agent"
}
},
"addresses": [
{
"value": {
"street": "12 avenue de l'Europe",
"zipcode": "31520",
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"country": "FR"
},
"from": "guest"
},
{
"value": {
"street": "21 rue de Rocroy",
"zipcode": "75000",
"city": "Paris",
"state": "Ile-de-France",
"country": "FR"
},
"from": "agent"
}
],
"emails": [
{
"value": { "email": "martin.dupont@example.com" },
"from": "guest"
}
],
"nationalities": [
{
"value": "FR",
"from": "guest"
},
{
"value": "ES",
"from": "guest"
}
],
"languages": [
{
"value": "fr",
"from": "guest"
},
{
"value": "es",
"from": "guest"
}
],
"customFields": {
"guest_status": {
"value": "DIAMOND",
"from": "guest"
},
"option": {
"value": "2022-02-19",
"from": "guest"
},
"lunch": {
"value": True,
"from": "guest"
},
"spa_revenus": {
"value": 888,
"from": "guest"
}
},
"socials": {
"avatar": {
"value": "https://www.example.com/avatars/martin-dupont.png",
"from": "agent"
},
"website": {
"value": "https://www.example.com",
"from": "system"
},
"facebook": {
"value": "https://www.facebook.com/example",
"from": "agent"
},
"linkedin": {
"value": { "url": "https://www.linkedin.com/in/example" },
"from": "system"
},
"twitter": {
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"from": "system"
}
},
"documents": {
"identity_card": {
"value": { "id": "123456789" },
"from": "pms"
},
"passport": {
"value": { "id": "123456789" },
"from": "pms"
},
"driving_licence": {
"value": { "id": "123456789" },
"from": "pms"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => [
'value' => 'MRS',
'from' => 'pms'
],
'gender' => [
'value' => 'M',
'from' => 'system'
],
'pmsId' => [
'value' => [
'id' => '139569',
'pms' => 'protelio'
],
'from' => 'pms'
],
'lastname' => [
'value' => 'Dupont',
'from' => 'pms'
],
'firstname' => [
'value' => 'Martin',
'from' => 'pms'
],
'middlename' => [
'value' => 'Fitzgerlad',
'from' => 'guest'
],
'birthdate' => [
'value' => [
'birthdate' => '1987-02-20'
],
'from' => 'guest'
],
'birthplace' => [
'value' => [
'city' => 'La Rochelle',
'zipcode' => '17000',
'country' => 'FR'
],
'from' => 'pms'
],
'company' => [
'value' => [
'title' => 'Web developer',
'company' => 'D-EDGE CRM'
],
'from' => 'guest'
],
'loyalty' => [
'value' => [
'program' => 'hotelrewards',
'id' => '123456789',
'status' => 'gold',
'points' => 107
],
'from' => 'guest'
],
'optedOut' => [
'marketing' => [
'value' => true,
'from' => 'guest'
],
'prestay' => [
'value' => false,
'from' => 'agent'
]
],
'addresses' => [
[
'value' => [
'street' => '12 avenue de l\'Europe',
'zipcode' => '31520',
'city' => 'Ramonville Saint-Agne',
'state' => 'Occitanie',
'country' => 'FR'
],
'from' => 'guest'
],
[
'value' => [
'street' => '21 rue de Rocroy',
'zipcode' => '75000',
'city' => 'Paris',
'state' => 'Ile-de-France',
'country' => 'FR'
],
'from' => 'agent'
]
],
'emails' => [
[
'value' => [
'email' => 'martin.dupont@example.com'
],
'from' => 'guest'
]
],
'nationalities' => [
[
'value' => 'FR',
'from' => 'guest'
],
[
'value' => 'ES',
'from' => 'guest'
]
],
'languages' => [
[
'value' => 'fr',
'from' => 'guest'
],
[
'value' => 'es',
'from' => 'guest'
]
],
'customFields' => [
'guest_status' => [
'value' => 'DIAMOND',
'from' => 'guest'
],
'option' => [
'value' => '2022-02-19',
'from' => 'guest'
],
'lunch' => [
'value' => true,
'from' => 'guest'
],
'spa_revenus' => [
'value' => 888,
'from' => 'guest'
]
],
'socials' => [
'avatar' => [
'value' => 'https://www.example.com/avatars/martin-dupont.png',
'from' => 'agent'
],
'website' => [
'value' => 'https://www.example.com',
'from' => 'system'
],
'facebook' => [
'value' => 'https://www.facebook.com/example',
'from' => 'agent'
],
'linkedin' => [
'value' => [
'url' => 'https://www.linkedin.com/in/example'
],
'from' => 'system'
],
'twitter' => [
'value' => [
'url' => 'https://twitter.com/example',
'followers' => 500
],
'from' => 'system'
]
],
'documents' => [
'identity_card' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
],
'passport' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
],
'driving_licence' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"title\": {\n \"value\": \"MRS\",\n \"from\": \"pms\"\n },\n \"gender\": {\n \"value\": \"M\",\n \"from\": \"system\"\n },\n \"pmsId\": {\n \"value\": {\n \"id\": \"139569\",\n \"pms\": \"protelio\"\n },\n \"from\": \"pms\"\n },\n \"lastname\": {\n \"value\": \"Dupont\",\n \"from\": \"pms\"\n },\n \"firstname\": {\n \"value\": \"Martin\",\n \"from\": \"pms\"\n },\n \"middlename\": {\n \"value\": \"Fitzgerlad\",\n \"from\": \"guest\"\n },\n \"birthdate\": {\n \"value\": {\n \"birthdate\": \"1987-02-20\"\n },\n \"from\": \"guest\"\n },\n \"birthplace\": {\n \"value\": {\n \"city\": \"La Rochelle\",\n \"zipcode\": \"17000\",\n \"country\": \"FR\"\n },\n \"from\": \"pms\"\n },\n \"company\": {\n \"value\": {\n \"title\": \"Web developer\",\n \"company\": \"D-EDGE CRM\"\n },\n \"from\": \"guest\"\n },\n \"loyalty\": {\n \"value\": {\n \"program\": \"hotelrewards\",\n \"id\": \"123456789\",\n \"status\": \"gold\",\n \"points\": 107\n },\n \"from\": \"guest\"\n },\n \"optedOut\": {\n \"marketing\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"prestay\": {\n \"value\": false,\n \"from\": \"agent\"\n }\n },\n \"addresses\": [\n {\n \"value\": {\n \"street\": \"12 avenue de l'Europe\",\n \"zipcode\": \"31520\",\n \"city\": \"Ramonville Saint-Agne\",\n \"state\": \"Occitanie\",\n \"country\": \"FR\"\n },\n \"from\": \"guest\"\n },\n {\n \"value\": {\n \"street\": \"21 rue de Rocroy\",\n \"zipcode\": \"75000\",\n \"city\": \"Paris\",\n \"state\": \"Ile-de-France\",\n \"country\": \"FR\"\n },\n \"from\": \"agent\"\n }\n ],\n \"emails\": [\n {\n \"value\": {\n \"email\": \"martin.dupont@example.com\"\n },\n \"from\": \"guest\"\n }\n ],\n \"nationalities\": [\n {\n \"value\": \"FR\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"ES\",\n \"from\": \"guest\"\n }\n ],\n \"languages\": [\n {\n \"value\": \"fr\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"es\",\n \"from\": \"guest\"\n }\n ],\n \"customFields\": {\n \"guest_status\": {\n \"value\": \"DIAMOND\",\n \"from\": \"guest\"\n },\n \"option\": {\n \"value\": \"2022-02-19\",\n \"from\": \"guest\"\n },\n \"lunch\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"spa_revenus\": {\n \"value\": 888,\n \"from\": \"guest\"\n }\n },\n \"socials\": {\n \"avatar\": {\n \"value\": \"https://www.example.com/avatars/martin-dupont.png\",\n \"from\": \"agent\"\n },\n \"website\": {\n \"value\": \"https://www.example.com\",\n \"from\": \"system\"\n },\n \"facebook\": {\n \"value\": \"https://www.facebook.com/example\",\n \"from\": \"agent\"\n },\n \"linkedin\": {\n \"value\": {\n \"url\": \"https://www.linkedin.com/in/example\"\n },\n \"from\": \"system\"\n },\n \"twitter\": {\n \"value\": {\n \"url\": \"https://twitter.com/example\",\n \"followers\": 500\n },\n \"from\": \"system\"\n }\n },\n \"documents\": {\n \"identity_card\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"passport\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"driving_licence\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n }\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": {\n \"value\": \"MRS\",\n \"from\": \"pms\"\n },\n \"gender\": {\n \"value\": \"M\",\n \"from\": \"system\"\n },\n \"pmsId\": {\n \"value\": {\n \"id\": \"139569\",\n \"pms\": \"protelio\"\n },\n \"from\": \"pms\"\n },\n \"lastname\": {\n \"value\": \"Dupont\",\n \"from\": \"pms\"\n },\n \"firstname\": {\n \"value\": \"Martin\",\n \"from\": \"pms\"\n },\n \"middlename\": {\n \"value\": \"Fitzgerlad\",\n \"from\": \"guest\"\n },\n \"birthdate\": {\n \"value\": {\n \"birthdate\": \"1987-02-20\"\n },\n \"from\": \"guest\"\n },\n \"birthplace\": {\n \"value\": {\n \"city\": \"La Rochelle\",\n \"zipcode\": \"17000\",\n \"country\": \"FR\"\n },\n \"from\": \"pms\"\n },\n \"company\": {\n \"value\": {\n \"title\": \"Web developer\",\n \"company\": \"D-EDGE CRM\"\n },\n \"from\": \"guest\"\n },\n \"loyalty\": {\n \"value\": {\n \"program\": \"hotelrewards\",\n \"id\": \"123456789\",\n \"status\": \"gold\",\n \"points\": 107\n },\n \"from\": \"guest\"\n },\n \"optedOut\": {\n \"marketing\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"prestay\": {\n \"value\": false,\n \"from\": \"agent\"\n }\n },\n \"addresses\": [\n {\n \"value\": {\n \"street\": \"12 avenue de l'Europe\",\n \"zipcode\": \"31520\",\n \"city\": \"Ramonville Saint-Agne\",\n \"state\": \"Occitanie\",\n \"country\": \"FR\"\n },\n \"from\": \"guest\"\n },\n {\n \"value\": {\n \"street\": \"21 rue de Rocroy\",\n \"zipcode\": \"75000\",\n \"city\": \"Paris\",\n \"state\": \"Ile-de-France\",\n \"country\": \"FR\"\n },\n \"from\": \"agent\"\n }\n ],\n \"emails\": [\n {\n \"value\": {\n \"email\": \"martin.dupont@example.com\"\n },\n \"from\": \"guest\"\n }\n ],\n \"nationalities\": [\n {\n \"value\": \"FR\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"ES\",\n \"from\": \"guest\"\n }\n ],\n \"languages\": [\n {\n \"value\": \"fr\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"es\",\n \"from\": \"guest\"\n }\n ],\n \"customFields\": {\n \"guest_status\": {\n \"value\": \"DIAMOND\",\n \"from\": \"guest\"\n },\n \"option\": {\n \"value\": \"2022-02-19\",\n \"from\": \"guest\"\n },\n \"lunch\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"spa_revenus\": {\n \"value\": 888,\n \"from\": \"guest\"\n }\n },\n \"socials\": {\n \"avatar\": {\n \"value\": \"https://www.example.com/avatars/martin-dupont.png\",\n \"from\": \"agent\"\n },\n \"website\": {\n \"value\": \"https://www.example.com\",\n \"from\": \"system\"\n },\n \"facebook\": {\n \"value\": \"https://www.facebook.com/example\",\n \"from\": \"agent\"\n },\n \"linkedin\": {\n \"value\": {\n \"url\": \"https://www.linkedin.com/in/example\"\n },\n \"from\": \"system\"\n },\n \"twitter\": {\n \"value\": {\n \"url\": \"https://twitter.com/example\",\n \"followers\": 500\n },\n \"from\": \"system\"\n }\n },\n \"documents\": {\n \"identity_card\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"passport\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"driving_licence\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n }\n }\n}")
.asString();Guest
Create a guest
Create a guest profile on an entity
POST
/
api
/
guestprofile
/
entities
/
{entity_id}
/
guests
/
create
Create
curl --request POST \
--url https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"title": {
"value": "MRS",
"from": "pms"
},
"gender": {
"value": "M",
"from": "system"
},
"pmsId": {
"value": {
"id": "139569",
"pms": "protelio"
},
"from": "pms"
},
"lastname": {
"value": "Dupont",
"from": "pms"
},
"firstname": {
"value": "Martin",
"from": "pms"
},
"middlename": {
"value": "Fitzgerlad",
"from": "guest"
},
"birthdate": {
"value": {
"birthdate": "1987-02-20"
},
"from": "guest"
},
"birthplace": {
"value": {
"city": "La Rochelle",
"zipcode": "17000",
"country": "FR"
},
"from": "pms"
},
"company": {
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"from": "guest"
},
"loyalty": {
"value": {
"program": "hotelrewards",
"id": "123456789",
"status": "gold",
"points": 107
},
"from": "guest"
},
"optedOut": {
"marketing": {
"value": true,
"from": "guest"
},
"prestay": {
"value": false,
"from": "agent"
}
},
"addresses": [
{
"value": {
"street": "12 avenue de l'Europe",
"zipcode": "31520",
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"country": "FR"
},
"from": "guest"
},
{
"value": {
"street": "21 rue de Rocroy",
"zipcode": "75000",
"city": "Paris",
"state": "Ile-de-France",
"country": "FR"
},
"from": "agent"
}
],
"emails": [
{
"value": {
"email": "martin.dupont@example.com"
},
"from": "guest"
}
],
"nationalities": [
{
"value": "FR",
"from": "guest"
},
{
"value": "ES",
"from": "guest"
}
],
"languages": [
{
"value": "fr",
"from": "guest"
},
{
"value": "es",
"from": "guest"
}
],
"customFields": {
"guest_status": {
"value": "DIAMOND",
"from": "guest"
},
"option": {
"value": "2022-02-19",
"from": "guest"
},
"lunch": {
"value": true,
"from": "guest"
},
"spa_revenus": {
"value": 888,
"from": "guest"
}
},
"socials": {
"avatar": {
"value": "https://www.example.com/avatars/martin-dupont.png",
"from": "agent"
},
"website": {
"value": "https://www.example.com",
"from": "system"
},
"facebook": {
"value": "https://www.facebook.com/example",
"from": "agent"
},
"linkedin": {
"value": {
"url": "https://www.linkedin.com/in/example"
},
"from": "system"
},
"twitter": {
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"from": "system"
}
},
"documents": {
"identity_card": {
"value": {
"id": "123456789"
},
"from": "pms"
},
"passport": {
"value": {
"id": "123456789"
},
"from": "pms"
},
"driving_licence": {
"value": {
"id": "123456789"
},
"from": "pms"
}
}
}
EOFconst url = 'https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: {value: 'MRS', from: 'pms'},
gender: {value: 'M', from: 'system'},
pmsId: {value: {id: '139569', pms: 'protelio'}, from: 'pms'},
lastname: {value: 'Dupont', from: 'pms'},
firstname: {value: 'Martin', from: 'pms'},
middlename: {value: 'Fitzgerlad', from: 'guest'},
birthdate: {value: {birthdate: '1987-02-20'}, from: 'guest'},
birthplace: {value: {city: 'La Rochelle', zipcode: '17000', country: 'FR'}, from: 'pms'},
company: {value: {title: 'Web developer', company: 'D-EDGE CRM'}, from: 'guest'},
loyalty: {
value: {program: 'hotelrewards', id: '123456789', status: 'gold', points: 107},
from: 'guest'
},
optedOut: {
marketing: {value: true, from: 'guest'},
prestay: {value: false, from: 'agent'}
},
addresses: [
{
value: {
street: '12 avenue de l\'Europe',
zipcode: '31520',
city: 'Ramonville Saint-Agne',
state: 'Occitanie',
country: 'FR'
},
from: 'guest'
},
{
value: {
street: '21 rue de Rocroy',
zipcode: '75000',
city: 'Paris',
state: 'Ile-de-France',
country: 'FR'
},
from: 'agent'
}
],
emails: [{value: {email: 'martin.dupont@example.com'}, from: 'guest'}],
nationalities: [{value: 'FR', from: 'guest'}, {value: 'ES', from: 'guest'}],
languages: [{value: 'fr', from: 'guest'}, {value: 'es', from: 'guest'}],
customFields: {
guest_status: {value: 'DIAMOND', from: 'guest'},
option: {value: '2022-02-19', from: 'guest'},
lunch: {value: true, from: 'guest'},
spa_revenus: {value: 888, from: 'guest'}
},
socials: {
avatar: {value: 'https://www.example.com/avatars/martin-dupont.png', from: 'agent'},
website: {value: 'https://www.example.com', from: 'system'},
facebook: {value: 'https://www.facebook.com/example', from: 'agent'},
linkedin: {value: {url: 'https://www.linkedin.com/in/example'}, from: 'system'},
twitter: {value: {url: 'https://twitter.com/example', followers: 500}, from: 'system'}
},
documents: {
identity_card: {value: {id: '123456789'}, from: 'pms'},
passport: {value: {id: '123456789'}, from: 'pms'},
driving_licence: {value: {id: '123456789'}, from: 'pms'}
}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create"
payload = {
"title": {
"value": "MRS",
"from": "pms"
},
"gender": {
"value": "M",
"from": "system"
},
"pmsId": {
"value": {
"id": "139569",
"pms": "protelio"
},
"from": "pms"
},
"lastname": {
"value": "Dupont",
"from": "pms"
},
"firstname": {
"value": "Martin",
"from": "pms"
},
"middlename": {
"value": "Fitzgerlad",
"from": "guest"
},
"birthdate": {
"value": { "birthdate": "1987-02-20" },
"from": "guest"
},
"birthplace": {
"value": {
"city": "La Rochelle",
"zipcode": "17000",
"country": "FR"
},
"from": "pms"
},
"company": {
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"from": "guest"
},
"loyalty": {
"value": {
"program": "hotelrewards",
"id": "123456789",
"status": "gold",
"points": 107
},
"from": "guest"
},
"optedOut": {
"marketing": {
"value": True,
"from": "guest"
},
"prestay": {
"value": False,
"from": "agent"
}
},
"addresses": [
{
"value": {
"street": "12 avenue de l'Europe",
"zipcode": "31520",
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"country": "FR"
},
"from": "guest"
},
{
"value": {
"street": "21 rue de Rocroy",
"zipcode": "75000",
"city": "Paris",
"state": "Ile-de-France",
"country": "FR"
},
"from": "agent"
}
],
"emails": [
{
"value": { "email": "martin.dupont@example.com" },
"from": "guest"
}
],
"nationalities": [
{
"value": "FR",
"from": "guest"
},
{
"value": "ES",
"from": "guest"
}
],
"languages": [
{
"value": "fr",
"from": "guest"
},
{
"value": "es",
"from": "guest"
}
],
"customFields": {
"guest_status": {
"value": "DIAMOND",
"from": "guest"
},
"option": {
"value": "2022-02-19",
"from": "guest"
},
"lunch": {
"value": True,
"from": "guest"
},
"spa_revenus": {
"value": 888,
"from": "guest"
}
},
"socials": {
"avatar": {
"value": "https://www.example.com/avatars/martin-dupont.png",
"from": "agent"
},
"website": {
"value": "https://www.example.com",
"from": "system"
},
"facebook": {
"value": "https://www.facebook.com/example",
"from": "agent"
},
"linkedin": {
"value": { "url": "https://www.linkedin.com/in/example" },
"from": "system"
},
"twitter": {
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"from": "system"
}
},
"documents": {
"identity_card": {
"value": { "id": "123456789" },
"from": "pms"
},
"passport": {
"value": { "id": "123456789" },
"from": "pms"
},
"driving_licence": {
"value": { "id": "123456789" },
"from": "pms"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => [
'value' => 'MRS',
'from' => 'pms'
],
'gender' => [
'value' => 'M',
'from' => 'system'
],
'pmsId' => [
'value' => [
'id' => '139569',
'pms' => 'protelio'
],
'from' => 'pms'
],
'lastname' => [
'value' => 'Dupont',
'from' => 'pms'
],
'firstname' => [
'value' => 'Martin',
'from' => 'pms'
],
'middlename' => [
'value' => 'Fitzgerlad',
'from' => 'guest'
],
'birthdate' => [
'value' => [
'birthdate' => '1987-02-20'
],
'from' => 'guest'
],
'birthplace' => [
'value' => [
'city' => 'La Rochelle',
'zipcode' => '17000',
'country' => 'FR'
],
'from' => 'pms'
],
'company' => [
'value' => [
'title' => 'Web developer',
'company' => 'D-EDGE CRM'
],
'from' => 'guest'
],
'loyalty' => [
'value' => [
'program' => 'hotelrewards',
'id' => '123456789',
'status' => 'gold',
'points' => 107
],
'from' => 'guest'
],
'optedOut' => [
'marketing' => [
'value' => true,
'from' => 'guest'
],
'prestay' => [
'value' => false,
'from' => 'agent'
]
],
'addresses' => [
[
'value' => [
'street' => '12 avenue de l\'Europe',
'zipcode' => '31520',
'city' => 'Ramonville Saint-Agne',
'state' => 'Occitanie',
'country' => 'FR'
],
'from' => 'guest'
],
[
'value' => [
'street' => '21 rue de Rocroy',
'zipcode' => '75000',
'city' => 'Paris',
'state' => 'Ile-de-France',
'country' => 'FR'
],
'from' => 'agent'
]
],
'emails' => [
[
'value' => [
'email' => 'martin.dupont@example.com'
],
'from' => 'guest'
]
],
'nationalities' => [
[
'value' => 'FR',
'from' => 'guest'
],
[
'value' => 'ES',
'from' => 'guest'
]
],
'languages' => [
[
'value' => 'fr',
'from' => 'guest'
],
[
'value' => 'es',
'from' => 'guest'
]
],
'customFields' => [
'guest_status' => [
'value' => 'DIAMOND',
'from' => 'guest'
],
'option' => [
'value' => '2022-02-19',
'from' => 'guest'
],
'lunch' => [
'value' => true,
'from' => 'guest'
],
'spa_revenus' => [
'value' => 888,
'from' => 'guest'
]
],
'socials' => [
'avatar' => [
'value' => 'https://www.example.com/avatars/martin-dupont.png',
'from' => 'agent'
],
'website' => [
'value' => 'https://www.example.com',
'from' => 'system'
],
'facebook' => [
'value' => 'https://www.facebook.com/example',
'from' => 'agent'
],
'linkedin' => [
'value' => [
'url' => 'https://www.linkedin.com/in/example'
],
'from' => 'system'
],
'twitter' => [
'value' => [
'url' => 'https://twitter.com/example',
'followers' => 500
],
'from' => 'system'
]
],
'documents' => [
'identity_card' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
],
'passport' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
],
'driving_licence' => [
'value' => [
'id' => '123456789'
],
'from' => 'pms'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"title\": {\n \"value\": \"MRS\",\n \"from\": \"pms\"\n },\n \"gender\": {\n \"value\": \"M\",\n \"from\": \"system\"\n },\n \"pmsId\": {\n \"value\": {\n \"id\": \"139569\",\n \"pms\": \"protelio\"\n },\n \"from\": \"pms\"\n },\n \"lastname\": {\n \"value\": \"Dupont\",\n \"from\": \"pms\"\n },\n \"firstname\": {\n \"value\": \"Martin\",\n \"from\": \"pms\"\n },\n \"middlename\": {\n \"value\": \"Fitzgerlad\",\n \"from\": \"guest\"\n },\n \"birthdate\": {\n \"value\": {\n \"birthdate\": \"1987-02-20\"\n },\n \"from\": \"guest\"\n },\n \"birthplace\": {\n \"value\": {\n \"city\": \"La Rochelle\",\n \"zipcode\": \"17000\",\n \"country\": \"FR\"\n },\n \"from\": \"pms\"\n },\n \"company\": {\n \"value\": {\n \"title\": \"Web developer\",\n \"company\": \"D-EDGE CRM\"\n },\n \"from\": \"guest\"\n },\n \"loyalty\": {\n \"value\": {\n \"program\": \"hotelrewards\",\n \"id\": \"123456789\",\n \"status\": \"gold\",\n \"points\": 107\n },\n \"from\": \"guest\"\n },\n \"optedOut\": {\n \"marketing\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"prestay\": {\n \"value\": false,\n \"from\": \"agent\"\n }\n },\n \"addresses\": [\n {\n \"value\": {\n \"street\": \"12 avenue de l'Europe\",\n \"zipcode\": \"31520\",\n \"city\": \"Ramonville Saint-Agne\",\n \"state\": \"Occitanie\",\n \"country\": \"FR\"\n },\n \"from\": \"guest\"\n },\n {\n \"value\": {\n \"street\": \"21 rue de Rocroy\",\n \"zipcode\": \"75000\",\n \"city\": \"Paris\",\n \"state\": \"Ile-de-France\",\n \"country\": \"FR\"\n },\n \"from\": \"agent\"\n }\n ],\n \"emails\": [\n {\n \"value\": {\n \"email\": \"martin.dupont@example.com\"\n },\n \"from\": \"guest\"\n }\n ],\n \"nationalities\": [\n {\n \"value\": \"FR\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"ES\",\n \"from\": \"guest\"\n }\n ],\n \"languages\": [\n {\n \"value\": \"fr\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"es\",\n \"from\": \"guest\"\n }\n ],\n \"customFields\": {\n \"guest_status\": {\n \"value\": \"DIAMOND\",\n \"from\": \"guest\"\n },\n \"option\": {\n \"value\": \"2022-02-19\",\n \"from\": \"guest\"\n },\n \"lunch\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"spa_revenus\": {\n \"value\": 888,\n \"from\": \"guest\"\n }\n },\n \"socials\": {\n \"avatar\": {\n \"value\": \"https://www.example.com/avatars/martin-dupont.png\",\n \"from\": \"agent\"\n },\n \"website\": {\n \"value\": \"https://www.example.com\",\n \"from\": \"system\"\n },\n \"facebook\": {\n \"value\": \"https://www.facebook.com/example\",\n \"from\": \"agent\"\n },\n \"linkedin\": {\n \"value\": {\n \"url\": \"https://www.linkedin.com/in/example\"\n },\n \"from\": \"system\"\n },\n \"twitter\": {\n \"value\": {\n \"url\": \"https://twitter.com/example\",\n \"followers\": 500\n },\n \"from\": \"system\"\n }\n },\n \"documents\": {\n \"identity_card\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"passport\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"driving_licence\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n }\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": {\n \"value\": \"MRS\",\n \"from\": \"pms\"\n },\n \"gender\": {\n \"value\": \"M\",\n \"from\": \"system\"\n },\n \"pmsId\": {\n \"value\": {\n \"id\": \"139569\",\n \"pms\": \"protelio\"\n },\n \"from\": \"pms\"\n },\n \"lastname\": {\n \"value\": \"Dupont\",\n \"from\": \"pms\"\n },\n \"firstname\": {\n \"value\": \"Martin\",\n \"from\": \"pms\"\n },\n \"middlename\": {\n \"value\": \"Fitzgerlad\",\n \"from\": \"guest\"\n },\n \"birthdate\": {\n \"value\": {\n \"birthdate\": \"1987-02-20\"\n },\n \"from\": \"guest\"\n },\n \"birthplace\": {\n \"value\": {\n \"city\": \"La Rochelle\",\n \"zipcode\": \"17000\",\n \"country\": \"FR\"\n },\n \"from\": \"pms\"\n },\n \"company\": {\n \"value\": {\n \"title\": \"Web developer\",\n \"company\": \"D-EDGE CRM\"\n },\n \"from\": \"guest\"\n },\n \"loyalty\": {\n \"value\": {\n \"program\": \"hotelrewards\",\n \"id\": \"123456789\",\n \"status\": \"gold\",\n \"points\": 107\n },\n \"from\": \"guest\"\n },\n \"optedOut\": {\n \"marketing\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"prestay\": {\n \"value\": false,\n \"from\": \"agent\"\n }\n },\n \"addresses\": [\n {\n \"value\": {\n \"street\": \"12 avenue de l'Europe\",\n \"zipcode\": \"31520\",\n \"city\": \"Ramonville Saint-Agne\",\n \"state\": \"Occitanie\",\n \"country\": \"FR\"\n },\n \"from\": \"guest\"\n },\n {\n \"value\": {\n \"street\": \"21 rue de Rocroy\",\n \"zipcode\": \"75000\",\n \"city\": \"Paris\",\n \"state\": \"Ile-de-France\",\n \"country\": \"FR\"\n },\n \"from\": \"agent\"\n }\n ],\n \"emails\": [\n {\n \"value\": {\n \"email\": \"martin.dupont@example.com\"\n },\n \"from\": \"guest\"\n }\n ],\n \"nationalities\": [\n {\n \"value\": \"FR\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"ES\",\n \"from\": \"guest\"\n }\n ],\n \"languages\": [\n {\n \"value\": \"fr\",\n \"from\": \"guest\"\n },\n {\n \"value\": \"es\",\n \"from\": \"guest\"\n }\n ],\n \"customFields\": {\n \"guest_status\": {\n \"value\": \"DIAMOND\",\n \"from\": \"guest\"\n },\n \"option\": {\n \"value\": \"2022-02-19\",\n \"from\": \"guest\"\n },\n \"lunch\": {\n \"value\": true,\n \"from\": \"guest\"\n },\n \"spa_revenus\": {\n \"value\": 888,\n \"from\": \"guest\"\n }\n },\n \"socials\": {\n \"avatar\": {\n \"value\": \"https://www.example.com/avatars/martin-dupont.png\",\n \"from\": \"agent\"\n },\n \"website\": {\n \"value\": \"https://www.example.com\",\n \"from\": \"system\"\n },\n \"facebook\": {\n \"value\": \"https://www.facebook.com/example\",\n \"from\": \"agent\"\n },\n \"linkedin\": {\n \"value\": {\n \"url\": \"https://www.linkedin.com/in/example\"\n },\n \"from\": \"system\"\n },\n \"twitter\": {\n \"value\": {\n \"url\": \"https://twitter.com/example\",\n \"followers\": 500\n },\n \"from\": \"system\"\n }\n },\n \"documents\": {\n \"identity_card\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"passport\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n },\n \"driving_licence\": {\n \"value\": {\n \"id\": \"123456789\"\n },\n \"from\": \"pms\"\n }\n }\n}")
.asString();Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Kind of profile. A profile produced by a merge carries merge, and reading one of its sources returns it.
Available options:
guest, extra, merge Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When the guest is merged, this property holds all guests IDs who compose the guest
Response
Resource
Was this page helpful?