# Availabilities
You can use the /v2/users/:user_id/availabilities endpoints to manage the availabilities your users.
This API is an extension of the Users API, that's why all url are prefixed with
/users/:user_id/. You can refer to the User API reference to have more informations about user creation.
# The availability object
Attributes
timezone string
The user timezone expressed according to TZ database name.
today_as_busy boolean
Prevent from booking on the same day.
past_as_busy boolean
Prevent from booking in the past.
belongs_to string
The
idof the user who own the Vyte Page.days_after_as_busy number
Prevent from booking in more than n days.
buffer_before number
Ensure users have at least n minutes free before each meeting.
buffer_after number
Ensure users have at least n minutes free after each meeting.
all_day_busy boolean
If the user has busy all day events on its calendar the full day will be marked as busy on Vyte
days hash
Here you can define the availabilities for each day of the week. We present the structure only for monday, but it is the same for the othe days.
+ Show child attributes
days. monday hash
Settings for monday.
+ Show child attributes
days.monday. enabled boolean
Whether or not we enable booking on that day.
days.monday. slots array of hashes
An array of slots defining when the user is available.
+ Show child attributes
THE AVAILABILITY OBJECT
{
"days": {
"monday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e066227db71d493",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e066220c571d494",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e0662ab1b71d495",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e0662590c71d496",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e06626d7871d497",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"saturday": {
"enabled": false
},
"sunday": {
"enabled": false
}
},
"past_as_busy": true,
"trim_scheduler": true,
"_id": "5f2d4abf1e0662085171d476",
"belongs_to": "5f2d4abf1e0662386371d475",
"timezone": "Europe/London",
"dates": [],
"today_as_busy": false,
"days_after_as_busy": 60,
"buffer_before": 0,
"buffer_after": 0,
"all_day_busy": true,
}
# Retrieve the availabilities of a user
ENDPOINT Authorization
apiKey
GET /v2/users/:user_id/availabilities HTTP/1.1
Path parameters
user_id string
The
idof the user whose availability you want to retrieve.
Query parameters
No parameters.
Returns
An Availability object if there is no error.
CODE SAMPLE
curl \
--request GET 'https://api.vyte.in/v2/users/5f2d28fb1e0662e70071d46b/availabilities' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
RESPONSE SAMPLE
{
"timezone": "Europe/London",
"today_as_busy": false,
"past_as_busy": true,
"days_after_as_busy": 60,
"buffer_before": 0,
"buffer_after": 0,
"all_day_busy": true,
"days": {
"monday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"saturday": {
"enabled": false
},
"sunday": {
"enabled": false
}
}
}
# Set the availabilities of a user
ENDPOINT Authorization
apiKey
POST /v2/users/:user_id/availabilities HTTP/1.1
Path parameters
user_id string
The
idof the user whose availability you want to create.
Query parameters
No parameters.
Body parameters
timezone string
The user timezone expressed according to TZ database name.
today_as_busy boolean
Prevent from booking on the same day.
past_as_busy boolean
Prevent from booking in the past.
days_after_as_busy number
Prevent from booking in more than n days.
buffer_before number
Ensure users have at least n minutes free before each meeting.
buffer_after number
Ensure users have at least n minutes free after each meeting.
all_day_busy boolean
If the user has busy all day events on its calendar the full day will be marked as busy on Vyte
days hash
Here you can define the availabilities for each day of the week. We present the structure only for monday, but it is the same for the othe days.
+ Show child attributes
days. monday hash
Settings for monday.
+ Show child attributes
days.monday. enabled boolean
Whether or not we enable booking on that day.
days.monday. slots array of hashes
An array of slots defining when the user is available.
+ Show child attributes
Returns
The created Availability object if no error occurred.
CODE SAMPLE
curl \
--request POST 'https://api.vyte.in/v2/users/5f2d28fb1e0662e70071d46b/availabilities' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
--header 'Content-Type: application/json' \
--data-raw '{
"timezone": "Europe/London",
"today_as_busy": false,
"past_as_busy": true,
"days_after_as_busy": 60,
"buffer_before": 0,
"buffer_after": 0,
"all_day_busy": true,
"days": {
"monday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"saturday": {
"enabled": false
},
"sunday": {
"enabled": false
}
}
}'
RESPONSE SAMPLE
{
"days": {
"monday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e066227db71d493",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e066220c571d494",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e0662ab1b71d495",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e0662590c71d496",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"_id": "5f2d70c51e06626d7871d497",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"saturday": {
"enabled": false
},
"sunday": {
"enabled": false
}
},
"past_as_busy": true,
"trim_scheduler": true,
"_id": "5f2d4abf1e0662085171d476",
"belongs_to": "5f2d4abf1e0662386371d475",
"timezone": "Europe/London",
"dates": [],
"today_as_busy": false,
"days_after_as_busy": 60,
"buffer_before": 0,
"buffer_after": 0,
"all_day_busy": true,
"updatedAt": "2020-08-07T15:18:29.263Z",
"createdAt": "2020-08-07T12:36:16.024Z",
"__v": 0
}
# Update the availabilities of a user
ENDPOINT Authorization
apiKey
PUT /v2/users/:user_id/availabilities HTTP/1.1
Path parameters
user_id string
The
idof the user whose availability you want to update.
Query parameters
No parameters.
Body parameters
timezone string
The user timezone expressed according to TZ database name.
today_as_busy boolean
Prevent from booking on the same day.
past_as_busy boolean
Prevent from booking in the past.
days_after_as_busy number
Prevent from booking in more than n days.
buffer_before number
Ensure users have at least n minutes free before each meeting.
buffer_after number
Ensure users have at least n minutes free after each meeting.
all_day_busy boolean
If the user has busy all day events on its calendar the full day will be marked as busy on Vyte
days hash
Here you can define the availabilities for each day of the week. We present the structure only for monday, but it is the same for the othe days.
+ Show child attributes
days. monday hash
Settings for monday.
+ Show child attributes
days.monday. enabled boolean
Whether or not we enable booking on that day.
days.monday. slots array of hashes
An array of slots defining when the user is available.
+ Show child attributes
Returns
The updated Availability object if no error occurred.
CODE SAMPLE
curl --request PUT 'https://api.vyte.in/v2/users/5f2d4abf1e0662386371d475/availabilities' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
--header 'Content-Type: application/json' \
--data-raw '{
"days": {
"monday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T17:00"
}
]
},
"saturday": {
"enabled": true,
"slots" : [
{
"start_time": "2018-01-01T09:00",
"end_time": "2018-01-01T12:00"
}
]
},
"sunday": {
"enabled": false
}
}
}'
RESPONSE SAMPLE
{
"days": {
"monday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e0662346c71d499",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"tuesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e0662419b71d49a",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"wednesday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e0662b11f71d49b",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"thursday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e06628d3971d49c",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"friday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e0662234a71d49d",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T16:00:00.000Z"
}
]
},
"saturday": {
"enabled": true,
"slots": [
{
"_id": "5f2d712c1e0662502e71d49e",
"start_time": "2018-01-01T08:00:00.000Z",
"end_time": "2018-01-01T11:00:00.000Z"
}
]
},
"sunday": {
"enabled": false
}
},
"past_as_busy": true,
"trim_scheduler": true,
"_id": "5f2d4abf1e0662085171d476",
"belongs_to": "5f2d4abf1e0662386371d475",
"timezone": "Europe/London",
"dates": [],
"today_as_busy": false,
"days_after_as_busy": 60,
"buffer_before": 0,
"buffer_after": 0,
"all_day_busy": true,
"updatedAt": "2020-08-07T15:20:12.611Z",
"createdAt": "2020-08-07T12:36:16.024Z",
"__v": 0
}
# Delete the availabilities of a user
ENDPOINT Authorization
apiKey
DELETE /v2/users/:user_id/availabilities HTTP/1.1
Path parameters
user_id string
The
idof the user whose availability you want to delete.
Query parameters
No parameters.
Returns
Returns an object containing the number of row affected and the status if there is no error, and returns an error otherwise.
curl --request DELETE 'https://api.vyte.in/v2/users/5f2d4abf1e0662386371d475/availabilities' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0'
RESPONSE SAMPLE
{
"n": 1,
"ok": 1
}