Add guest consent for ZenScribe

POST https://api.zenoti.com/v1/zenscribe/consents

This API adds the guest consent for owner ID.

Before you begin

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

Endpoint

POST /v1/zenscribe/consents

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

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Request body

Field Type Required Description
owner-id integer (int32) No Unique identifier for the owner (Appointment, Guest, Service, etc.).
owner-type enum () No Type of owner.
signature string No Guest’s signature in Base64 or Data URL format.
guest_id integer (int32) No Unique identifier of the guest giving consent.

Response

Success (201 Created)

{
  "error": {}
}

Response fields

Field Type Description
error object

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/zenscribe/consents' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "owner-id": 0,
  "owner-type": "",
  "signature": "string",
  "guest_id": 0
}'
const response = await fetch('https://api.zenoti.com/v1/zenscribe/consents', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'owner-id': 0,
  'owner-type': '',
  signature: 'string',
  guest_id: 0
})
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/zenscribe/consents',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'owner-id': 0, 'owner-type': '', 'signature': 'string', 'guest_id': 0}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new {
    owner-id = 0,
    owner-type = "",
    signature = "string",
    guest_id = 0
}),
    Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/zenscribe/consents", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/zenscribe/consents')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { owner-id: 0, owner-type: '', signature: 'string', guest_id: 0 }.to_json
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
403 403
429 Too many requests -- rate limit exceeded