Onboardly
Get started

Survey preferences

Read or override which question set a candidate is asked, and whether their survey sends automatically.

GET/api/v1/candidates/{id}/churnguard/prefs#

Read a candidate’s pinned question set and auto-send override.

Headers

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

Status codes

2002xx
null for either field means it inherits the account default (see Account settings below).
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4034xx
Your account’s plan does not include ChurnGuard.
ChurnGuard is not included in your plan.
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.
cURL
curl \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/churnguard/prefs" \
  -H "X-Api-Key: $ONB_KEY"
200 · No override set — inherits the account default
{
  "questionSetId": null,
  "autoSend": null
}
200 · Pinned and auto-send on
{
  "questionSetId": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
  "autoSend": true
}
PATCH/api/v1/candidates/{id}/churnguard/prefs#

Pin a question set for this candidate, and/or override whether their survey sends automatically.

Headers

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

Request fields

questionSetIdstring or nulloptional
null clears the pin — falls back to the account default.
autoSendboolean or nulloptional
null inherits the account default (see Account settings below).

Status codes

2002xx
The value just written.
4004xx
Malformed body, an unrecognised field, an invalid field type, or a questionSetId that does not resolve for your account.
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4034xx
Your account’s plan does not include ChurnGuard.
ChurnGuard is not included in your plan.
4044xx
Unknown, cross-tenant, or (a candidate id) sandbox-hidden. One outcome, never a 403.
Not found
4094xx
This candidate’s preferences row already belongs to a different account — should not happen in normal use.
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 itself failed — retry.
This resource is temporarily unavailable. Try again shortly.
cURL
curl -X PATCH \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/churnguard/prefs" \
  -H "X-Api-Key: $ONB_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "questionSetId": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
  "autoSend": true
}'
Request body
{
  "questionSetId": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
  "autoSend": true
}
200 · Response
{
  "questionSetId": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
  "autoSend": true
}
PreviousRetrieve survey resultsNextAccount settings