Onboardly
Get started

Approved templates

List the approved WhatsApp templates this platform can send outside the 24-hour messaging window.

GET/api/v1/templates#

Headers

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

Status codes

2002xx
Every currently-usable template.
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.

Not candidate-scoped

This is the platform’s own template registry, not a per-candidate resource — there is no {id} in the path.

  • Only templates Meta has actually approved are listed — a submitted-but-pending template never appears here.
  • No Content SID is included — it identifies a template on this platform’s own Twilio account, which you cannot send against directly.
  • The partner_sendable field on each entry marks which keys Send a template will accept as template_key — a POSITIVE allowlist, narrower than "approved and usable" above.
cURL
curl \
  "https://rca-onboardly.com/api/v1/templates" \
  -H "X-Api-Key: $ONB_KEY"
200 · Response
{
  "templates": [
    {
      "key": "consent",
      "body": "Hi {{1}}, this is {{2}} agent. {{3}} wants to collect your recruitment compliance documents. Do you consent?",
      "variables": [
        "candidateName",
        "agencyName",
        "recruiterName"
      ],
      "category": "UTILITY",
      "partner_sendable": false
    },
    {
      "key": "chase",
      "body": "Hi {{1}}, we're still waiting on: {{2}}. Please send these when you can, or reply here if you need any help.",
      "variables": [
        "candidateName",
        "pendingDocs"
      ],
      "category": "UTILITY",
      "partner_sendable": true
    }
  ]
}
PreviousApplication form linksNextRetrieve document content