Skip to main content
GET
Get a WhatsApp Template Pool
Safety and behavior notes
  • The returned pool belongs to a WABA-level template catalog that can be shared by multiple client records.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Query Parameters

workflow_id
string<uuid>
required

Workflow whose pool is being inspected.

Response

Successful response.

success
enum<boolean>
required
Available options:
true
pool
object
required
opening
object
required

Resolved opening mode and eligible templates.

available
object
required
send_whatsapp
object
required

Templates the voice agent sends on WhatsApp when the 24h window is closed. Empty means those sends use the follow-up pool.

opening_segments
object[]
required

The task's opening template by lead segment, in priority order (see PUT /template-pools/opening-segments). Empty when none is set.

Last modified on September 8, 2026