Create a guest form

POST https://api.zenoti.com/v1/Guests/{guest_id}/Forms

This API helps you to create a guest form for the specified guest.You must specify the unique identifier of the guest as guest_id in the API request.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

POST /v1/Guests/{guest_id}/Forms

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Query parameters

Parameter Type Required Default Description
guest_id string Yes — Mandatory Unique 32-character identifier of the guest.

Request body

Field Type Required Description
form_id string No Unique identifier of the form.
is_required_filled boolean No Denotes if the required fields are filled or not. True - means the required fields are filled. False - means the required fields are not filled.
is_reviewed boolean No Denotes if the form is reviewed. True - means the form is reviewed. False - means the form is not reviewed.
is_form_submitted boolean No Denotes if the form is submitted or not. True - means the form is submitted. False - means the form is not submitted.
tag_id string No Unique identifier of the tag in the form.
Source string No Source where the form is saved.

Response

Success (201 Created)

{
  "success": true
}

Response fields

Field Type Description
success boolean

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/Guests/{guest_id}/Forms?guest_id={{guest_id}}' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "form_id": "string",
  "is_required_filled": true,
  "is_reviewed": true,
  "is_form_submitted": true,
  "tag_id": "string",
  "Source": "string"
}'
const response = await fetch('https://api.zenoti.com/v1/Guests/{guest_id}/Forms', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  form_id: 'string',
  is_required_filled: true,
  is_reviewed: true,
  is_form_submitted: true,
  tag_id: 'string',
  Source: 'string'
})
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/Guests/{guest_id}/Forms',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'form_id': 'string', 'is_required_filled': True, 'is_reviewed': True, 'is_form_submitted': True, 'tag_id': 'string', 'Source': 'string'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new {
    form_id = "string",
    is_required_filled = true,
    is_reviewed = true,
    is_form_submitted = true,
    tag_id = "string",
    Source = "string"
}),
    Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/Guests/{guest_id}/Forms", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/Guests/{guest_id}/Forms')
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 = { form_id: 'string', is_required_filled: true, is_reviewed: true, is_form_submitted: true, tag_id: 'string', Source: '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