Onboardly
Get started

Partner API Create candidates, collect documents and references, retrieve the compliance pack.

Get an API key

Quiet hours

Read or set the hours during which the assistant will not message candidates.

GET/api/v1/settings/quiet-hours#

Read the account’s quiet-hours window — the hours outbound chase and template sends are suppressed.

Headers

X-Api-Keyonb_live_<key_id>_<secret>required
Your issued Partner API key — see Authentication.

Status codes

2002xx
The resolved window. Unset falls back to the platform default.
4014xx
Missing, malformed, unknown, revoked or expired key. Every authentication failure looks the same — see Authentication.
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5035xx
The setting could not be read right now.
This resource is temporarily unavailable. Try again shortly.
  • Account-level, not candidate-level — there is no {id} in this path.
  • start_hour === end_hour with enabled: true means the window is ALWAYS quiet, not "no window" — every chase and template send is suppressed.
  • The window is half-open and wraps midnight: with start_hour: 21, end_hour: 8, the account is quiet from 21:00 up to (not including) 08:00 local time.
cURL
curl \
  "https://rca-onboardly.com/api/v1/settings/quiet-hours" \
  -H "X-Api-Key: $ONB_KEY"
200 · Response
{
  "enabled": true,
  "start_hour": 21,
  "end_hour": 8
}
PATCH/api/v1/settings/quiet-hours#

Set any subset of the quiet-hours window.

Headers

X-Api-Keyonb_live_<key_id>_<secret>required
Your issued Partner API key — see Authentication.

Request fields

enabledbooleanoptional
Optional if start_hour or end_hour is present. Never null.
start_hourintegeroptional
0–23. Optional if another field is present. Never null.
end_hourintegeroptional
0–23. Optional if another field is present. Never null.

Status codes

2002xx
Window updated. Body is the resolved window after the write.
4004xx
Malformed body, an unrecognised key, an empty body, or a field that failed validation.
Invalid request bodyUnknown field: {field}At least one of enabled, start_hour or end_hour is requiredenabled must be true or false{field} must be a whole number from {min} to {max}start_hour and end_hour cannot be the same while quiet hours are enabled
4014xx
Missing, malformed, unknown, revoked or expired key. Every authentication failure looks the same — see Authentication.
4034xx
The key’s user has the viewer team role, or their account could not be read just then (retry) — or the key was created Read only (code: "key_read_only", refused before anything else). Checked before the body or any id — see Authentication.
Your team role doesn't allow this. Ask your team's admin or owner.This API key is read-only. Create a full-access key to make changes.
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5005xx
The write could not be completed.
This resource is temporarily unavailable. Try again shortly.
5035xx
The setting could not be written, the stored window could not be read to check a partial body (nothing written), or the post-write confirmation read failed — the write may already have landed.
This resource is temporarily unavailable. Try again shortly.
  • A write that would LEAVE the window enabled with start_hour === end_hour is refused with 400 — that shape means the account is quiet all day, silencing every chase and template send. A field you omit counts at its stored value, so { "start_hour": 8 } onto a stored enabled window ending at 8 is refused too.
  • At least one of the three fields must be present; any subset is accepted, and unset fields are left unchanged.
cURL
curl -X PATCH \
  "https://rca-onboardly.com/api/v1/settings/quiet-hours" \
  -H "X-Api-Key: $ONB_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_hour": 22
}'
Request body
{
  "start_hour": 22
}
200 · Response
{
  "enabled": true,
  "start_hour": 22,
  "end_hour": 8
}
PreviousAssistant nameNextOverview