Update a guest form
This API helps you to update the details of a V2 guest form for the specified guest. You must specify the unique identifier of the guest as guest_id in the API request.Note: Retrieving uploaded files, signatures and annoations are not supported.
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
PUT /v1/Guests/{guest_id}/Forms
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | 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 | string | No | Denotes if the form is reviewed. True - means the form is reviewed. False - means the form is not reviewed. |
| is_form_submitted | string | 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 (200 OK)
{}
Example
curl --request PUT \
--url 'https://api.zenoti.com/v1/Guests/{guest_id}/Forms' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"form_id": "string",
"is_required_filled": true,
"is_reviewed": "string",
"is_form_submitted": "string",
"tag_id": "string",
"Source": "string"
}'
const response = await fetch('https://api.zenoti.com/v1/Guests/{guest_id}/Forms', {
method: 'PUT',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
form_id: 'string',
is_required_filled: true,
is_reviewed: 'string',
is_form_submitted: 'string',
tag_id: 'string',
Source: 'string'
})
});
const data = await response.json();
import requests
response = requests.put(
'https://api.zenoti.com/v1/Guests/{guest_id}/Forms',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'form_id': 'string', 'is_required_filled': True, 'is_reviewed': 'string', 'is_form_submitted': 'string', '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 = "string",
is_form_submitted = "string",
tag_id = "string",
Source = "string"
}),
Encoding.UTF8, "application/json");
var response = await client.PutAsync(
"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::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { form_id: 'string', is_required_filled: true, is_reviewed: 'string', is_form_submitted: 'string', tag_id: 'string', Source: 'string' }.to_json
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |