Redeem a guest's Guest Pass membership

PUT https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem

Purpose: Use this API to redeem the benefits of the guest's Guest Pass membership.

You must specify the guest_id and guestpass_id, and invoice_id to redeem the benefits.

Before you begin

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

Endpoint

PUT /v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem

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 Unique identifier of the guest.
guestpass_id string Yes Unique identifier of the guest's guestpass membership.

Request body

Field Type Required Description
invoice_id (guid) string Yes Unique identifier of the invoice to redeem the guest pass.

Response

Success (200 OK)

{
  "error": {}
}

Response fields

Field Type Description
error object

Example

curl --request PUT \
  --url 'https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice_id (guid)": "string"
}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem', {
  method: 'PUT',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ 'invoice_id (guid)': 'string' })
});
const data = await response.json();
import requests

response = requests.put(
    'https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'invoice_id (guid)': 'string'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new { invoice_id (guid) = "string" }),
    Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/guestpass/{guestpass_id}/redeem')
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 = { invoice_id (guid): '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