Onboardly
Get started

Assistant name

Read or set the name the WhatsApp assistant introduces itself with.

null means no override is set — the account’s agency label is used instead.

GET/api/v1/settings/assistant#

Read the name the WhatsApp assistant currently introduces itself with.

Headers

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

Status codes

2002xx
The resolved name; null means no override is set — the account’s agency label is used instead.
4014xx
Missing, malformed, unknown or revoked 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.

Account-level, not candidate-level — there is no {id} in this path.

cURL
curl \
  "https://rca-onboardly.com/api/v1/settings/assistant" \
  -H "X-Api-Key: $ONB_KEY"
200 · Response
{
  "name": null
}
PATCH/api/v1/settings/assistant#

Set or clear the assistant’s display name.

Headers

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

Request fields

namestring or nullrequired
Up to 60 characters if non-null. null clears the override — never gated. A non-null value is checked against your plan and WhatsApp-sender configuration; see the note below.

Status codes

2002xx
Name set or cleared. Body is the resolved value after the write.
4004xx
Malformed body, an unrecognised key, a missing name key, or a name that failed validation (not a string, blank, or over 60 characters).
Invalid request bodyUnknown field: {field}name is required
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4034xx
Refused — your plan does not include personalize, or the account is still sending from the shared platform WhatsApp number. Both refusals return the identical message; the real reason is logged server-side only, never in the response.
A custom assistant name is not available on this account.
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 on this environment right now — same message as the 500 above; only the status distinguishes them.
This resource is temporarily unavailable. Try again shortly.
  • Clearing (null) always succeeds, regardless of plan or WhatsApp-sender state.
  • The account’s agency_name setting is a separate field this endpoint does not read or write — the engine does not consult it at turn time, so there is nothing to expose here.
cURL
curl -X PATCH \
  "https://rca-onboardly.com/api/v1/settings/assistant" \
  -H "X-Api-Key: $ONB_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": null
}'
Request body
{
  "name": null
}
200 · Response
{
  "name": null
}
PreviousRetrieve the compliance packNextQuiet hours