Freeze the membership of a guest
This API helps you to freeze the membership of a guest.
You must specify appropriate details for the guest_id and membership_id parameters in the API request.
Optionally, you can specify the necessary details for the start_date, end_date, fee, type, and changed_unfreeze_date parameters in the API request body.
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}/memberships/{user_membership_id}/freeze
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. |
| user_membership_id | string | Yes | Mandatory Unique 32-character identifier of the guest's membership. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| start_date | string (date) | No | Beginning date of the membership freeze. |
| end_date | string (date) | No | Ending date of the membership freeze. |
| fee | integer (int32) | No | This is the freeze fee on the membership charged to the guest. |
| type | enum (2, 3) | No | Type of membership freeze process. Indicates one of the following: 2 - Freeze benefits and shift next payment date by freeze period. 3 - Allow guest to use benefits and skip payments in freeze period. Note: You can only specify the value of this parameter as either 2 or 3. |
| changed_unfreeze_date | string (date) | No | Date that replaces the previous end_date value of the guest membership. In other words, changed_unfreeze_date is the new date until which the guest's membership is to be frozen. Format: YYYY-MM-DD. |
Response
Success (200 OK)
{
"error": {
"code": 502,
"message": "Freeze Fee cannot be less than 0$"
}
}
Response fields
| Field | Type | Description |
|---|---|---|
| error | object | |
| error.code | integer | |
| error.message | string |
Example
curl --request PUT \
--url 'https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"start_date": "2026-01-15",
"end_date": "2026-01-15",
"fee": 0,
"type": "2",
"changed_unfreeze_date": "2026-01-15"
}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze', {
method: 'PUT',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
start_date: '2026-01-15',
end_date: '2026-01-15',
fee: 0,
type: '2',
changed_unfreeze_date: '2026-01-15'
})
});
const data = await response.json();
import requests
response = requests.put(
'https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'start_date': '2026-01-15', 'end_date': '2026-01-15', 'fee': 0, 'type': '2', 'changed_unfreeze_date': '2026-01-15'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new {
start_date = "2026-01-15",
end_date = "2026-01-15",
fee = 0,
type = "2",
changed_unfreeze_date = "2026-01-15"
}),
Encoding.UTF8, "application/json");
var response = await client.PutAsync(
"https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze')
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 = { start_date: '2026-01-15', end_date: '2026-01-15', fee: 0, type: '2', changed_unfreeze_date: '2026-01-15' }.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 |