Publishing · Queue
Updates a schedule.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the publishing resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
profileIdstringrequiredqueueIdstringnamestringtimezonestringrequiredslotsarray of objectrequireddayOfWeekinteger0 to 6.
timestringMatches
^([0-1][0-9]|2[0-3]):[0-5][0-9]$.
activebooleanDefault
true.setAsDefaultbooleanreshuffleExistingbooleanDefault
false.
Example
curl -X PUT "https://api.pozy.ai/v1/queue/slots" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"profileId": "6a0b6573846efc28aaa9a3ff",
"timezone": "America/New_York",
"slots": [
{
"dayOfWeek": 1,
"time": "2026-10-02T09:00:00.000Z"
}
]
}'const res = await fetch("https://api.pozy.ai/v1/queue/slots", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
profileId: "6a0b6573846efc28aaa9a3ff",
timezone: "America/New_York",
slots: [
{
dayOfWeek: 1,
time: "2026-10-02T09:00:00.000Z"
}
]
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.put(
"https://api.pozy.ai/v1/queue/slots",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"profileId": "6a0b6573846efc28aaa9a3ff",
"timezone": "America/New_York",
"slots": [
{
"dayOfWeek": 1,
"time": "2026-10-02T09:00:00.000Z",
},
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanscheduleobject9 child fields
_idstringprofileIdstringnamestringtimezonestringslotsarray of object2 child fields
dayOfWeekinteger0 to 6.
timestringMatches
^([0-1][0-9]|2[0-3]):[0-5][0-9]$.
activebooleanisDefaultbooleancreatedAtstring (date-time)updatedAtstring (date-time)
nextSlotsarray of string (date-time)reshuffledCountintegerskippedDailyLimitintegerisNewQueueboolean
200 response
{
"success": true,
"schedule": {
"_id": "635d87e261ae344ef27fd1df",
"profileId": "6a0b6573846efc28aaa9a3ff",
"name": "Acme",
"timezone": "America/New_York",
"slots": [
{
"dayOfWeek": 1,
"time": "2026-10-02T09:00:00.000Z"
}
],
"active": true,
"isDefault": true,
"createdAt": "2026-10-02T09:00:00.000Z",
"updatedAt": "2026-10-02T09:00:00.000Z"
},
"nextSlots": [
"2026-10-02T09:00:00.000Z"
],
"reshuffledCount": 42,
"skippedDailyLimit": 1,
"isNewQueue": true
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.