Onboardly
Get started

Update outreach settings

Override how hard, and how often, one candidate is chased for documents and references.

PATCH/api/v1/candidates/{id}/outreach#

Override this candidate’s document- and reference-chase behaviour.

Headers

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

Request fields

chase_attempts_overrideinteger or nulloptional
1–10. The SAME column POST /candidates’s docs_chase_attempts writes at creation — this is the only way to edit it afterwards.
doc_attempts_overrideinteger or nulloptional
1–10 rejected uploads allowed before handoff to a human.
chase_when_quietboolean or nulloptional
Whether reminders may send during this candidate’s quiet hours.
notify_on_compliantboolean or nulloptional
Whether the recruiter is notified when this candidate becomes fully compliant.
chase_frequency_overrideinteger or nulloptional
1–14 days between reminders — a raw day count, not the dashboard’s Low/Normal/Urgent enum.
reference_chase_attempts_overrideinteger or nulloptional
0–10. The SAME column POST /candidates’s reference_chase_attempts writes at creation.

Status codes

2002xx
Only the fields you sent were written.
4004xx
No recognised fields in the body, a field outside the closed set, or a field out of range.
Unknown field: {field}No fields to update
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4044xx
Unknown, cross-tenant, or (a candidate id) sandbox-hidden. One outcome, never a 403.
Not found
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5005xx
The update could not be verified as written, or the service is temporarily unavailable.
Failed to update outreach settingsThis resource is temporarily unavailable. Try again shortly.

Two fields have no dashboard equivalent at all: chase_frequency_override and reference_chase_attempts_override. A response can carry unavailableFields for a column not yet present on your deployment — every other requested field still lands.

cURL
curl -X PATCH \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/outreach" \
  -H "X-Api-Key: $ONB_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "chase_attempts_override": 5,
  "reference_chase_attempts_override": 2
}'
Request body
{
  "chase_attempts_override": 5,
  "reference_chase_attempts_override": 2
}
200 · Response
{
  "id": "3f9c1a2e-8b7d-4c1f-9a3e-2d5f8c1b4e70",
  "updatedFields": [
    "chase_attempts_override",
    "reference_chase_attempts_override"
  ]
}
PreviousUpdate a profileNextAdd documents