--- title: "Create a guest" url: "https://docs.unified.to/property/guest/Create_a_guest" description: "Create a guest with Unified's Guest API (POST /property/{connection_id}/guest). Filter by fields and raw. Supported by 5 Guest integrations." date: "2026-10-29T08:41:27.988Z" updated: "2026-10-29T08:41:27.988Z" --- # Create a guest Updated: October 29, 2026 POST/property/{connection\_id}/guest Creates a PropertyGuest. Provide the unified PropertyGuest fields in the request body; they are mapped to the provider's API. Returns the created PropertyGuest. ## Parameters **fields**string array id created\_at updated\_at name first\_name last\_name emails telephones address language nationality company\_name image\_url notes metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection ## Payload **id**string unique identifier for the guest **created\_at**date-time when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **name**string the guest full name **first\_name**string the guest first name **last\_name**string the guest last name **emails** array email addresses of the guest **telephones** array telephone numbers of the guest **address**object postal address of the guest **language**string the guest preferred language (ISO 639-1) **nationality**string the guest nationality **company\_name**string the guest company name **image\_url**string URL of the guest picture **notes**string free-text notes about the guest **metadata** array custom field values **raw** raw data from the integration ## Returns [PropertyGuest](https://docs.unified.to/property/guest/model.md) | Response field | Type | Required | Description | | ------------------------ | --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | No | unique identifier for the guest | | created\_at | string (date-time) | No | when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | the guest full name | | first\_name | string | No | the guest first name | | last\_name | string | No | the guest last name | | emails | PropertyEmail\[\] | No | email addresses of the guest | | emails\[\].email | string | Yes | the email address | | emails\[\].type | enum | No | the kind of email address Values: WORK, HOME, OTHER | | telephones | PropertyTelephone\[\] | No | telephone numbers of the guest | | telephones\[\].telephone | string | Yes | the telephone number | | telephones\[\].type | enum | No | the kind of telephone number Values: WORK, HOME, MOBILE, FAX, OTHER | | address | object | No | postal address of the guest | | address.address1 | string | No | first line of the street address | | address.address2 | string | No | second line of the street address | | address.city | string | No | city or locality | | address.region | string | No | state, province or regional area | | address.region\_code | string | No | state, province or regional area code | | address.postal\_code | string | No | postal or ZIP code | | address.country | string | No | country name | | address.country\_code | string | No | ISO 3166-1 alpha-2 country code | | language | string | No | the guest preferred language (ISO 639-1) | | nationality | string | No | the guest nationality | | company\_name | string | No | the guest company name | | image\_url | string | No | URL of the guest picture | | notes | string | No | free-text notes about the guest | | metadata | PropertyMetadata\[\] | No | custom field values | | metadata\[\].id | string | No | the custom field identifier | | metadata\[\].slug | string | No | the custom field key | | metadata\[\].value | object | No | the custom field value | | metadata\[\].namespace | string | No | the scope or origin of the custom field | | metadata\[\].format | enum | No | the data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | metadata\[\].extra\_data | object | No | additional data about the custom field | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const results = await sdk.property.createPropertyGuest({ connectionId, propertyGuest: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'POST', url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/guest', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("POST", "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw= req, _ := http.NewRequest("POST", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.post(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request POST \ --url 'https://api.unified.to/property/5de520f96e439b002043d8dc/guest?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```