Skip to content
Developers
Voxbi Cockpit APIs
API Guides
All endpoints

Update your schedule email preferences (user)

Turn your own schedule emails on or off. Send one or both keys; a key you leave out keeps its value. The current values are in the profile, under preferences.schedule.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
pbx path · string · uuid *
UUID of the PBX tenant. Must be the tenant the token belongs to; anything else is refused with 403 rather than answered from another tenant.
employee path · string · uuid *
UUID of the Tempus employee whose queue this is. Must be the caller's own employee record: a queue is built from the approval rows addressed to one person, so another employee's id is refused rather than quietly answered with your own.
accept header · string
example: application/json

Request body · required · application/json

Request schema
roster_emailsboolean
Receive the roster PDF when a schedule is published.
example: 1
status_emailsboolean
Receive the emails sent when a shift moves you onto its status and back.
example:

Responses

OK. The schedule email preferences after the update.
Response schema
roster_emails*boolean
example: 1
status_emails*boolean
example:
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Forbidden. The caller is outside this PBX, or asked for an employee record that is not their own.
Response schema
messagestring
example: You do not have access to this PBX.
Not found. No such employee in this PBX.
Response schema
messagestring
example: User not found.
Unprocessable. Neither key was sent, or a value is not a boolean.
Response schema
messagestring
example: The roster emails field is required when status emails is not present.
errorsobject
Free-form object
patch https://cockpit.voxbi.com/api/v1/v2/{pbx}/employee/{employee}/preferences/schedule
Base URL
Request sample 
curl -X PATCH 'https://cockpit.voxbi.com/api/v1/v2/{pbx}/employee/{employee}/preferences/schedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"status_emails":false}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/v2/{pbx}/employee/{employee}/preferences/schedule', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "status_emails": false
}),
});

const data = await response.json();
console.log(data);
import requests

response = requests.patch('https://cockpit.voxbi.com/api/v1/v2/{pbx}/employee/{employee}/preferences/schedule',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "status_emails": false
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'PATCH',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"status_emails\": false
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/v2/{pbx}/employee/{employee}/preferences/schedule', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"status_emails": false
}
No example for this status.
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
No example for this status.
No example for this status.
No example for this status.