Create a recurring employee blockout time
Description
Recurring blockout time blocks the specified time for repetive days. To create a recurring blockout time supply the blockouttime request object to this api and api will create the blockout time for specific therapist. To create a recurring block out time supply the recurring blockout time object. Request and respones of both recurring and non recurring block out times are given in examples.
Returns
Returns the newly created blockout times in the list of BlockOutTime objects in both recurring and non-recurring scenarios or returns an error object if any error is occured.
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
POST /v1/employees/{employee_id}/blockouttimes
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| employee_id | string | Yes | Unique identifier of the employee. |
Response
Success (201 Created)
{
"block_out_times": [
{
"...": "..."
}
],
"error": {}
}
Response fields
| Field | Type | Description |
|---|---|---|
| block_out_times | object[] | |
| block_out_times[].block_out_time_id | string | |
| block_out_times[].employee | object | |
| block_out_times[].block_out_time_type | object | |
| block_out_times[].start_time | string | |
| block_out_times[].end_time | string | |
| block_out_times[].start_time_in_center | string | |
| block_out_times[].end_time_in_center | string | |
| block_out_times[].notes | object | |
| block_out_times[].recurring_block_out_time | object | |
| error | object |
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/employees/{employee_id}/blockouttimes' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/employees/{employee_id}/blockouttimes', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/employees/{employee_id}/blockouttimes',
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/employees/{employee_id}/blockouttimes");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/employees/{employee_id}/blockouttimes')
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 |