Delete relationship between guests
The purpose of this API is to delete the relationship between two guests.
For example the relationship could be Family, Friends, Spouse.
Generally, when a group booking is made, the front-desk staff selects relationship between the host and the guest. This is for simple identification as well as payment collection. There may be cases when the guests do not want any relationship to be added. In such cases, you can use this API to delete the relationship.
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
DELETE / v1/guests/{guest_id}/relationships/{guest_relationship_id}
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. |
| guest_relationship_id | string | Yes | Mandatory Unique 32 digit identifier of the guest for whom the host wants to book an appointment. |
Response
Success (204 No Content)
{}
Example
curl --request DELETE \
--url 'https://api.zenoti.com/ v1/guests/{guest_id}/relationships/{guest_relationship_id}' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/ v1/guests/{guest_id}/relationships/{guest_relationship_id}', {
method: 'DELETE',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.delete(
'https://api.zenoti.com/ v1/guests/{guest_id}/relationships/{guest_relationship_id}',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.DeleteAsync(
"https://api.zenoti.com/ v1/guests/{guest_id}/relationships/{guest_relationship_id}");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/ v1/guests/{guest_id}/relationships/{guest_relationship_id}')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
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 |