Create a guest
This API helps you to create a guest. To create a new guest, you must fill the available details of the guest along with the mandatory fields that are set in the organization guest settings and then supply that guest object. In return, you will receive the guest object along with the unique identifier of the guest. Refer to the examples to know the minimum and maximum details required to create a guest.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
POST /v1/guests
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| expand | string | No | — | Guest object supports multiple parameters like tags, referrals, address_info, preferences, and login_info. Pass the required parameters using expand query parameter to include the same in the response. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| RAW_BODY | string (json) | No |
Response
Success (201 Created)
{}
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/guests' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"RAW_BODY": "string"
}'
const response = await fetch('https://api.zenoti.com/v1/guests', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({ RAW_BODY: 'string' })
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/guests',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'RAW_BODY': 'string'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new { RAW_BODY = "string" }),
Encoding.UTF8, "application/json");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/guests", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/guests')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { RAW_BODY: 'string' }.to_json
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |