Claim Aveda Birthday Gift

POST https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift

This API claims an Aveda birthday gift for a specific guest using a valid offer code. It processes the gift through Aveda integration and updates the guest’s records.

Before you begin

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

Endpoint

POST /v1/guests/{guest_id}/aveda/birthday_gift

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

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
guest_id integer (int32) Yes Unique identifier of the guest.

Response

Success (201 Created)

{
  "error": {}
}

Response fields

Field Type Description
error object

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/aveda/birthday_gift')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.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
500 500