CX Bot & Inbox API

WhatsApp CX Bot and Multi-user Inbox API for ENI Networks

Get global platform statistics (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/admin/stats"

Empty

List organizations with pagination and filters (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?string

page?integer

Default1

limit?integer

Default20

plan?string

Value in"FREE" | "STARTER" | "PROFESSIONAL" | "ENTERPRISE"

status?string

Value in"ACTIVE" | "SUSPENDED" | "CANCELLED"

sortBy?string

Default"createdAt"

sortOrder?string

Default"desc"

Value in"asc" | "desc"

Response Body

curl -X get "https://loading/api/v1/admin/organizations"

Empty

Create a new organization with initial admin user (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

slug*string

plan?string

Default"FREE"

Value in"FREE" | "STARTER" | "PROFESSIONAL" | "ENTERPRISE"

maxAgents?integer

adminEmail*string

Formatemail

adminName*string

Response Body

curl -X post "https://loading/api/v1/admin/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string",    "adminEmail": "user@example.com",    "adminName": "string"  }'

Empty

Get organization detail (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/admin/organizations/string"

Empty

Update an organization (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

plan?string

Value in"FREE" | "STARTER" | "PROFESSIONAL" | "ENTERPRISE"

status?string

Value in"ACTIVE" | "SUSPENDED" | "CANCELLED"

maxAgents?integer|null

Response Body

curl -X patch "https://loading/api/v1/admin/organizations/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Bulk status change on organizations (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"suspend" | "activate" | "cancel"

selection*

Response Body

curl -X post "https://loading/api/v1/admin/organizations/bulk" \  -H "Content-Type: application/json" \  -d '{    "action": "suspend",    "selection": {      "mode": "ids"    }  }'

Empty

List users of an organization (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/admin/organizations/string/users"

Empty

Resend invitation email to a user in an organization (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId*string

Response Body

curl -X post "https://loading/api/v1/admin/organizations/string/resend-invite" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

Empty

Get server environment configuration (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/admin/system-config"

Empty

Generate tokens to enter a specific organization's context (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

orgId*string

Response Body

curl -X post "https://loading/api/v1/admin/enter-org/string"

Empty

List Stripe prices grouped by product (for plan configuration)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/admin/stripe/prices"

Empty

List active tools available for agents

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/agent-tools"

Empty

Extract tool parameter values from conversation context using AI

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

toolId*string

conversationId*string

Response Body

curl -X post "https://loading/api/v1/agent-tools/extract-params" \  -H "Content-Type: application/json" \  -d '{    "toolId": "string",    "conversationId": "string"  }'

Empty

Execute a tool with given parameters

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

toolId*string

params*object

conversationId*string

Response Body

curl -X post "https://loading/api/v1/agent-tools/execute" \  -H "Content-Type: application/json" \  -d '{    "toolId": "string",    "params": {},    "conversationId": "string"  }'

Empty

Overview KPIs and charts

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

Response Body

curl -X get "https://loading/api/v1/analytics/overview"

Empty

Conversation volume, response times, categories

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/analytics/conversations"

Empty

Per-agent performance metrics

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/analytics/agents"

Empty

Bot performance metrics

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/analytics/bot"

Empty

Campaign delivery funnel and costs

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/analytics/campaigns"

Empty

Free-form AI analytics query

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

question*string

history?array<>

Response Body

curl -X post "https://loading/api/v1/analytics/ai-query" \  -H "Content-Type: application/json" \  -d '{    "question": "string"  }'

Empty

Check if AI analytics is available for this tenant

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/analytics/ai-status"

Empty

Toggle AI analytics on/off

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/analytics/ai-toggle"

Empty

List API keys for the organization (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/api-keys"

Empty

Create a new API key (admin only). Returns the full key ONCE.

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/api-keys"

Empty

Update an API key (admin only)

Authorization

AuthorizationBearer <token>

In: header

curl -X patch "https://loading/api/v1/api-keys/{id}"

Delete an API key permanently (admin only)

Authorization

AuthorizationBearer <token>

In: header

curl -X delete "https://loading/api/v1/api-keys/{id}"

Self-service registration (creates org + admin user)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

companyName*string

name*string

email*string

Formatemail

password*string

Response Body

curl -X post "https://loading/api/v1/auth/register" \  -H "Content-Type: application/json" \  -d '{    "companyName": "string",    "name": "string",    "email": "user@example.com",    "password": "string"  }'

Empty

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

password*string

Response Body

curl -X post "https://loading/api/v1/auth/login" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "password": "string"  }'

Empty

Set or update password for the authenticated user

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

password*string

Length6 <= length

Response Body

curl -X post "https://loading/api/v1/auth/set-password" \  -H "Content-Type: application/json" \  -d '{    "password": "string"  }'

Empty

Request magic link code

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

Response Body

curl -X post "https://loading/api/v1/auth/request-code" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

Empty

Verify magic link code and get JWT

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

code*string

Length6 <= length <= 6

Response Body

curl -X post "https://loading/api/v1/auth/verify-code" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "code": "string"  }'

Empty

Refresh access token

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

refreshToken*string

Response Body

curl -X post "https://loading/api/v1/auth/refresh" \  -H "Content-Type: application/json" \  -d '{    "refreshToken": "string"  }'

Empty

Get current user profile

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/auth/me"

Empty

Mark onboarding as completed for the current org

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/auth/complete-onboarding"

Empty

Create Stripe Checkout session

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/billing/checkout-session"

Empty

Create Stripe Customer Portal session

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/billing/portal-session"

Empty

Add extra agent block to subscription

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/billing/extra-agents"

Empty

Get subscription info

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/billing/subscription"

Empty

Preview a plan change (features gained/lost, proration)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/billing/preview-plan-change"

Empty

Preview subscription cancellation (features that will be lost)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/billing/cancel-preview"

Empty

Cancel subscription at end of billing period

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/billing/cancel-subscription"

Empty

Get bot configuration for the current organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config"

Empty

Create a new bot config (draft)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

engine?string

Value in"NATIVE" | "FLOW" | "GRAPH"

Response Body

curl -X post "https://loading/api/v1/bot-config" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Empty

Upsert bot configuration

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X put "https://loading/api/v1/bot-config" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List all bot configs for the organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/list"

Empty

Duplicate a bot config (deep copy with intents)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Response Body

curl -X post "https://loading/api/v1/bot-config/string/duplicate" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Activate a bot config (deactivates the currently active one)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X put "https://loading/api/v1/bot-config/string/activate"

Empty

Delete a draft bot config (cannot delete the active one)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/string"

Empty

Reveal the full (unmasked) API key

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/reveal-key"

Empty

Test LLM with a message

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message*string

Response Body

curl -X post "https://loading/api/v1/bot-config/test" \  -H "Content-Type: application/json" \  -d '{    "message": "string"  }'

Empty

Sandbox chat - admin converses with bot without sending to WA

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message*string

history?array<any>

Response Body

curl -X post "https://loading/api/v1/bot-config/test-sandbox" \  -H "Content-Type: application/json" \  -d '{    "message": "string"  }'

Empty

Get available models for a provider

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

provider*string

Response Body

curl -X get "https://loading/api/v1/bot-config/models?provider=OPENAI"

Empty

Validate an AI API key

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

apiKey*string

model*string

Response Body

curl -X post "https://loading/api/v1/bot-config/validate-key" \  -H "Content-Type: application/json" \  -d '{    "provider": "string",    "apiKey": "string",    "model": "string"  }'

Empty

Get prompt version history

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/prompt-versions"

Empty

Rollback to a previous prompt version

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/bot-config/prompt-versions/string/activate"

Empty

List provider presets for the current organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/presets"

Empty

Create a provider preset

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X post "https://loading/api/v1/bot-config/presets" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete a provider preset

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/presets/string"

Empty

Update a provider preset

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X put "https://loading/api/v1/bot-config/presets/string"

Empty

List bot feedback

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

cursor?string

Response Body

curl -X get "https://loading/api/v1/bot-feedback"

Empty

Submit feedback on a bot message

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

messageId*string

conversationId*string

rating*integer

reason?string

comment?string

isHallucination?boolean

Response Body

curl -X post "https://loading/api/v1/bot-feedback" \  -H "Content-Type: application/json" \  -d '{    "messageId": "string",    "conversationId": "string",    "rating": 0  }'

Empty

Get current month usage and plan limits

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/usage"

Empty

Get last 12 months of usage

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/usage/history"

Empty

List knowledge base documents

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/documents"

Empty

Upload a document to the knowledge base

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?string

name?string

Response Body

curl -X post "https://loading/api/v1/bot-config/documents"

Empty

Delete a document and its chunks

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/documents/string"

Empty

Get document processing status

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/bot-config/documents/string/status"

Empty

List bot intents for the current organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/intents"

Empty

Create a bot intent

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/bot-config/intents"

Empty

Delete a bot intent

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/intents/string"

Empty

Update a bot intent

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X put "https://loading/api/v1/bot-config/intents/string"

Empty

Reorder bot intents

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids?array<string>

Response Body

curl -X put "https://loading/api/v1/bot-config/intents/reorder" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List config snapshots (metadata only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/snapshots"

Empty

Create a config snapshot

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/bot-config/snapshots"

Empty

Restore a config snapshot

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/bot-config/snapshots/string/restore"

Empty

Delete a config snapshot

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/snapshots/string"

Empty

Export bot config as JSON file

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

tier?string

Value in"config" | "standard" | "full"

Response Body

curl -X get "https://loading/api/v1/bot-config/export"

Empty

Export bot config as ZIP with binary files

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

tier?string

Value in"standard" | "full"

Response Body

curl -X get "https://loading/api/v1/bot-config/export-zip"

Empty

Import bot config from JSON or ZIP file

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?string

restore?string

Set to 'true' to restore immediately instead of saving as snapshot

Response Body

curl -X post "https://loading/api/v1/bot-config/import"

Empty

Get chunks for a document

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/bot-config/documents/string/chunks"

Empty

Test RAG query

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query?string

Response Body

curl -X post "https://loading/api/v1/bot-config/test-rag" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Get embedding model information

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/embedding-info"

Empty

List bot media assets

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-config/media"

Empty

Upload a bot media file

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?string

name?string

displayName?string

description?string

caption?string

Response Body

curl -X post "https://loading/api/v1/bot-config/media"

Empty

Update bot media metadata

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X patch "https://loading/api/v1/bot-config/media/string"

Empty

Delete a bot media file

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/bot-config/media/string"

Empty

Serve bot media file for preview

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/bot-config/media/string/file"

Empty

Serve video thumbnail image

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/bot-config/media/string/thumbnail"

Empty

Get bot quality metrics for the current org

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

days?integer

Number of days to look back

Default30

Response Body

curl -X get "https://loading/api/v1/bot-config/metrics/quality"

Empty

List bot sessions with filtering and pagination

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

closureType?string

Filter by closure type

Value in"RESOLVED_CONFIRMED" | "ABANDONED" | "ESCALATED"

days?integer

Default30

page?integer

Default1

limit?integer

Default20

Response Body

curl -X get "https://loading/api/v1/bot-config/metrics/sessions"

Empty

Bot performance metrics from Langfuse traces

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

days?integer

Default7

Range1 <= value <= 30

force?boolean

Defaultfalse

Response Body

curl -X get "https://loading/api/v1/bot-config/metrics/traces"

Empty

Get detailed pipeline view for a single trace

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

traceId*string

Response Body

curl -X get "https://loading/api/v1/bot-config/metrics/traces/string"

Empty

Look up client account by phone number

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

phone*string

Phone number (10 digits or full with country code)

Response Body

curl -X get "https://loading/api/v1/phone-lookup/string"

Empty

Reprocesar conversaciones BOT_HANDLING sin respuesta del bot

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X post "https://loading/api/v1/bot-config/reprocess-pending"

{
  "data": {
    "reprocessed": 0,
    "errors": 0,
    "total": 0
  }
}

Empty

List all bot templates (including unpublished)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/admin/bot-templates"

Empty

Create a bot template

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X post "https://loading/api/v1/admin/bot-templates" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Publish current org config as a template

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orgId*string

name*string

slug*string

Response Body

curl -X post "https://loading/api/v1/admin/bot-templates/from-config" \  -H "Content-Type: application/json" \  -d '{    "orgId": "string",    "name": "string",    "slug": "string"  }'

Empty

Delete a bot template

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/admin/bot-templates/string"

Empty

Update a bot template

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X put "https://loading/api/v1/admin/bot-templates/string"

Empty

List published bot templates

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/bot-templates"

Empty

Import a bot template into the org's config

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/bot-templates/import/string"

Empty

List bot tools for this organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/tools"

Empty

Create a bot tool

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/tools"

Empty

Delete a bot tool

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/tools/{id}"

Empty

Update a bot tool

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X put "https://loading/api/v1/tools/{id}"

Empty

Test a tool with example parameters

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/tools/{id}/test"

Empty

List all campaigns

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/campaigns"

Empty

Create a campaign (bulk template send)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

templateId*string

recipients*array<>

Response Body

curl -X post "https://loading/api/v1/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "templateId": "string",    "recipients": [      {        "phone": "string"      }    ]  }'

Empty

Get aggregated stats across all campaigns

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/campaigns/stats/global"

Empty

Get real costs from Meta per template and WABA total (last 90 days)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/campaigns/meta-costs"

Empty

Get calculated real cost for a campaign based on Meta analytics

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/campaigns/string/meta-cost"

Empty

Get campaign detail with paginated recipients

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

page?integer

Default1

limit?integer

Default25

status?string

Response Body

curl -X get "https://loading/api/v1/campaigns/string"

Empty

Export campaign recipients as CSV

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

status?string

Response Body

`text/csv`

curl -X get "https://loading/api/v1/campaigns/string/export"

"string"

Empty

Get aggregated recipient stats for a campaign

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/campaigns/string/stats"

Empty

Estimate campaign cost before sending

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

templateId*string

recipients*array<>

Response Body

curl -X post "https://loading/api/v1/campaigns/estimate" \  -H "Content-Type: application/json" \  -d '{    "templateId": "string",    "recipients": [      {        "phone": "string"      }    ]  }'

Empty

Get current WhatsApp pricing rates

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/campaigns/pricing"

Empty

Bulk actions on campaigns (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"delete"

selection*

Response Body

curl -X post "https://loading/api/v1/campaigns/bulk" \  -H "Content-Type: application/json" \  -d '{    "action": "delete",    "selection": {      "mode": "ids"    }  }'

Empty

Get public branding info (logo, company name, WhatsApp phone)

Query Parameters

clientId?integer

Response Body

curl -X get "https://loading/api/v1/config/branding"

Empty

Update branding settings (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

companyLogoUrl?string

Response Body

curl -X put "https://loading/api/v1/config/branding" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Get aggregated platform statistics (public, cached 60s)

Response Body

curl -X get "https://loading/api/v1/config/platform-stats"

Empty

Get authenticated branding info for current organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/my-branding"

Empty

Get server environment configuration (super admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config"

Empty

Upload company logo (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

logo*string

Response Body

curl -X post "https://loading/api/v1/config/logo" \  -F logo="string"

Empty

Remove company logo (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/config/logo"

Empty

Check if auto-categorization is enabled for this organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/auto-categorize"

Empty

Toggle auto-categorization (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

curl -X put "https://loading/api/v1/config/auto-categorize" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

Empty

Check if the bot is enabled for this organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/bot-enabled"

Empty

Toggle bot enabled/disabled (admin)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

curl -X put "https://loading/api/v1/config/bot-enabled" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

Empty

Check if media auto-display is enabled for this organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/media-auto-display"

Empty

Toggle media auto-display (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

curl -X put "https://loading/api/v1/config/media-auto-display" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

Empty

Get bot handling mode flags

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/bot-mode"

Empty

Update bot handling mode flags (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

autoHandle?boolean

manualAssign?boolean

Response Body

curl -X put "https://loading/api/v1/config/bot-mode" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List external connections for the organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/connections"

Empty

Create an external connection (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/connections"

Empty

Get unmasked secrets for a connection (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/connections/{id}/secrets"

Empty

Delete an external connection (admin only). Cascades InboxDataSource, nullifies BotTool.connectionId.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/connections/{id}"

Empty

Update an external connection (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X put "https://loading/api/v1/connections/{id}"

Empty

Test an external connection with example variables (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/connections/{id}/test"

Empty

List/search contacts

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?string

cursor?string

limit?integer

Default50

Response Body

curl -X get "https://loading/api/v1/contacts"

Empty

Get contact by WhatsApp ID

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

waId*string

Response Body

curl -X get "https://loading/api/v1/contacts/string"

Empty

Update contact name or category

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

waId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contactName?string

category?string

Response Body

curl -X patch "https://loading/api/v1/contacts/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List conversations with filters

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

status?string

Value in"BOT_HANDLING" | "HUMAN_HANDLING" | "OPEN" | "WAITING_FOR_CUSTOMER" | "CLOSED"

assignedTo?string

search?string

cursor?string

limit?integer

Default50

subFilter?string

Sub-filter pill (unread = unreadCount > 0, needs_action = last message from customer)

Value in"unread" | "needs_action"

sort?string

Sort order for conversations

Default"newest"

Value in"newest" | "oldest" | "waiting_longest" | "created_newest" | "created_oldest"

Response Body

curl -X get "https://loading/api/v1/conversations"

Empty

Get distinct conversation categories

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/conversations/categories"

Empty

Get sub-filter counts (all, unread, needs_action)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

status?string

assignedTo?string

teamId?string

category?string

origin?string

Response Body

curl -X get "https://loading/api/v1/conversations/counts"

Empty

Bulk re-classify and re-route open conversations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

scope?string

Value in"unassigned" | "all" | "uncategorized"

Response Body

curl -X post "https://loading/api/v1/conversations/re-classify" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Re-classify a single conversation using AI

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/conversations/string/re-classify"

Empty

Re-evaluate routing rules and reassign team

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/conversations/{id}/re-route"

Get conversation by ID

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/conversations/string"

Empty

Update conversation (status, assignment, etc.)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X patch "https://loading/api/v1/conversations/string"

Empty

Agent takes over conversation from bot

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/conversations/string/takeover"

Empty

Generate a handoff summary preview for agent review

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/conversations/string/generate-handoff-summary"

Empty

Return conversation to bot handling

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

handoffSummary?string

Agent-edited handoff context for the bot

Response Body

curl -X post "https://loading/api/v1/conversations/string/return-to-bot" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Mark conversation as read

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/conversations/string/read"

Empty

Assign conversation to an agent

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/conversations/{id}/assign"

Unassign conversation (release it for other agents)

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/conversations/{id}/unassign"

Resolve conversation (mark as resolved)

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/conversations/{id}/resolve"

Mark conversation for follow-up

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

note?string

Response Body

curl -X post "https://loading/api/v1/conversations/{id}/follow-up" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Remove follow-up from conversation

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/conversations/{id}/follow-up"

Empty

Get other conversations from the same contact

Authorization

AuthorizationBearer <token>

In: header

curl -X get "https://loading/api/v1/conversations/{id}/contact-history"

Simulate a single incoming conversation via webhook pipeline

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contactName?string

contactPhone?string

messages?array<string>

category?string

Response Body

curl -X post "https://loading/api/v1/dev/simulate/conversation" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Simulate a batch of incoming conversations

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

count?integer

Default5

categories?array<string>

Response Body

curl -X post "https://loading/api/v1/dev/simulate/batch" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Simulate an incoming message on an existing conversation

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conversationId*string

body?string

Response Body

curl -X post "https://loading/api/v1/dev/simulate/message" \  -H "Content-Type: application/json" \  -d '{    "conversationId": "string"  }'

Empty

Delete all simulated conversations and messages

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/dev/simulate/cleanup"

Empty

Simulate a template status update webhook from Meta

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

templateName*string

event*string

reason?string

Response Body

curl -X post "https://loading/api/v1/dev/simulate/template-status" \  -H "Content-Type: application/json" \  -d '{    "templateName": "string",    "event": "APPROVED"  }'

Empty

Health check

Response Body

curl -X get "https://loading/api/v1/health"

Empty

Readiness check (verifies DB connection)

Response Body

curl -X get "https://loading/api/v1/ready"

Empty

List inbox data sources for the organization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/inbox-data-sources"

Empty

Create an inbox data source (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/inbox-data-sources"

Empty

Delete an inbox data source (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/inbox-data-sources/{id}"

Empty

Update an inbox data source (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X put "https://loading/api/v1/inbox-data-sources/{id}"

Empty

Test a data source with a phone number (admin only)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/inbox-data-sources/{id}/test"

Empty

Fetch external data for a conversation's contact (all roles)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

conversationId*string

Query Parameters

force?boolean

Response Body

curl -X get "https://loading/api/v1/inbox-data-sources/data/string"

Empty

Get integration config for the organization (secrets masked)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/integrations"

Empty

Delete integration config (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/integrations"

Empty

Create or update integration config (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X put "https://loading/api/v1/integrations"

Empty

Get unmasked secrets for the organization (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/integrations/secrets"

Empty

Test integration connection with a phone number (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/integrations/test"

Empty

Fetch external data for a conversation's contact

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

conversationId*string

Query Parameters

force?boolean

Response Body

curl -X get "https://loading/api/v1/integrations/data/string"

Empty

List invitations for current org

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/invitations"

Empty

Create a single invitation

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

role?string

Value in"AGENT" | "ADMIN"

Response Body

curl -X post "https://loading/api/v1/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

Empty

Create multiple invitations at once

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invitations*array<>

Response Body

curl -X post "https://loading/api/v1/invitations/bulk" \  -H "Content-Type: application/json" \  -d '{    "invitations": [      {}    ]  }'

Empty

Resend invitation email

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/invitations/{id}/resend"

Revoke a pending invitation

Authorization

AuthorizationBearer <token>

In: header

curl -X delete "https://loading/api/v1/invitations/{id}"

Get invitation details by token (public)

curl -X get "https://loading/api/v1/invitations/token/{token}"

Accept invitation and create account

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

password*string

curl -X post "https://loading/api/v1/invitations/accept/{token}" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "password": "string"  }'

Get messages for a conversation (cursor-based pagination)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

cursor?string

limit?integer

Default50

Response Body

curl -X get "https://loading/api/v1/conversations/string/messages"

Empty

Send a message in a conversation

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Value in"text" | "template" | "interactive"

body?string

templateName?string

templateVariables?array<string>

Response Body

curl -X post "https://loading/api/v1/conversations/string/messages" \  -H "Content-Type: application/json" \  -d '{    "type": "text"  }'

Empty

Send a media message (image, video, audio, document)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*string

caption?string

Response Body

curl -X post "https://loading/api/v1/conversations/string/messages/media" \  -F file="string"

Empty

Send a reaction to a message via WhatsApp

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emoji*string

Response Body

curl -X post "https://loading/api/v1/messages/string/react" \  -H "Content-Type: application/json" \  -d '{    "emoji": "string"  }'

Empty

Retry media download for a message with failed/missing media

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/messages/string/retry-media"

Empty

Toggle message visibility (hide/unhide)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/messages/string/toggle-hide"

Empty

List failed outbound messages (admin only)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

status?string

Value in"FAILED" | "PENDING"

permanent?boolean

templateName?string

search?string

page?integer

Default1

pageSize?integer

Default25

Response Body

curl -X get "https://loading/api/v1/messages/failed"

Empty

Get failed message statistics (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/messages/failed/stats"

Empty

Retry sending a failed message (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/messages/string/retry-send"

Empty

Mark a failed message as permanently discarded (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/messages/string/discard"

Empty

Retry multiple failed messages (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

messageIds?array<string>

Response Body

curl -X post "https://loading/api/v1/messages/failed/bulk-retry" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Discard multiple failed messages (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

messageIds?array<string>

Response Body

curl -X post "https://loading/api/v1/messages/failed/bulk-discard" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Receive bot response from n8n workflow

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conversationId*string

message*

category?string

escalate?boolean

botContext?object

Response Body

curl -X post "https://loading/api/v1/n8n/bot-response" \  -H "Content-Type: application/json" \  -d '{    "conversationId": "string",    "message": {}  }'

Empty

Get current plan usage and limits

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/plan/usage"

Empty

List available plans (public, no auth)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/public/plans"

Empty

Get own user profile

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/profile"

Empty

Update own profile name

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Response Body

curl -X patch "https://loading/api/v1/profile" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Empty

Upload user avatar image

Authorization

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

avatar*string

Response Body

curl -X post "https://loading/api/v1/profile/avatar" \  -F avatar="string"

Empty

Remove user avatar

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/profile/avatar"

Empty

Change own password

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

currentPassword*string

newPassword*string

Response Body

curl -X post "https://loading/api/v1/profile/change-password" \  -H "Content-Type: application/json" \  -d '{    "currentPassword": "string",    "newPassword": "string"  }'

Empty

List active quick replies (all agents)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/quick-replies"

Empty

Create a quick reply (admin only)

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/quick-replies"

List all quick replies including inactive (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/quick-replies/all"

Empty

Update a quick reply (admin only)

Authorization

AuthorizationBearer <token>

In: header

curl -X patch "https://loading/api/v1/quick-replies/{id}"

Delete a quick reply (admin only)

Authorization

AuthorizationBearer <token>

In: header

curl -X delete "https://loading/api/v1/quick-replies/{id}"

Bulk actions on quick replies (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"delete" | "activate" | "deactivate"

selection*

Response Body

curl -X post "https://loading/api/v1/quick-replies/bulk" \  -H "Content-Type: application/json" \  -d '{    "action": "delete",    "selection": {      "mode": "ids"    }  }'

Empty

Upload media attachment for a quick reply (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?string

Response Body

curl -X post "https://loading/api/v1/quick-replies/string/media"

Empty

Remove media from a quick reply (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/quick-replies/string/media"

Empty

Get organization maintenance mode settings

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules/maintenance"

Empty

Update organization maintenance mode settings (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

maintenanceMode*boolean

maintenanceMessage?string

Response Body

curl -X put "https://loading/api/v1/routing-rules/maintenance" \  -H "Content-Type: application/json" \  -d '{    "maintenanceMode": true  }'

Empty

Get organization off-hours auto-reply settings

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules/off-hours"

Empty

Update organization off-hours auto-reply settings (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

offHoursAutoReply*boolean

offHoursMessage?string

Response Body

curl -X put "https://loading/api/v1/routing-rules/off-hours" \  -H "Content-Type: application/json" \  -d '{    "offHoursAutoReply": true  }'

Empty

Get organization business hours schedule

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules/business-hours"

Empty

Update organization business hours schedule (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

timezone*string

isEnabled*boolean

slots*array<>

Response Body

curl -X put "https://loading/api/v1/routing-rules/business-hours" \  -H "Content-Type: application/json" \  -d '{    "timezone": "string",    "isEnabled": true,    "slots": [      {}    ]  }'

Empty

Get the default team for the organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules/default-team"

Empty

Update the default team for the organization (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

defaultTeamId?string|null

Response Body

curl -X put "https://loading/api/v1/routing-rules/default-team" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Run routing rules retroactively on existing conversations (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status?array<>

Filter conversations by status (default all non-closed)

dryRun?boolean

If true, return what would change without making changes

Response Body

curl -X post "https://loading/api/v1/routing-rules/run-now" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List all routing rules ordered by priority

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules"

Empty

Create a routing rule (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

priority?integer

teamId*string

matchType?string

Value in"ANY" | "ALL"

conditions*array<>

isActive?boolean

Response Body

curl -X post "https://loading/api/v1/routing-rules" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "teamId": "string",    "conditions": [      {}    ]  }'

Empty

Preview conflicts for a routing rule without saving

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

teamId*string

conditions*string

JSON-encoded conditions array

matchType?string

Value in"ANY" | "ALL"

excludeRuleId?string

Response Body

curl -X get "https://loading/api/v1/routing-rules/check-conflicts?teamId=string&conditions=string"

Empty

Update a routing rule (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

priority?integer

teamId?string

matchType?string

Value in"ANY" | "ALL"

conditions?array<>

isActive?boolean

Response Body

curl -X patch "https://loading/api/v1/routing-rules/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete a routing rule (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/routing-rules/string"

Empty

Reorder routing rules by priority (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderedIds*array<string>

Response Body

curl -X post "https://loading/api/v1/routing-rules/reorder" \  -H "Content-Type: application/json" \  -d '{    "orderedIds": [      "string"    ]  }'

Empty

Get idle agent detection settings

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/routing-rules/idle-agent"

Empty

Update idle agent detection settings (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled?boolean

timeoutMinutes?integer

action?string

Value in"UNASSIGN" | "REASSIGN" | "RETURN_TO_BOT"

notifyCustomer?boolean

messageUnassign?string

messageReassign?string

messageReturnToBot?string

Response Body

curl -X put "https://loading/api/v1/routing-rules/idle-agent" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Manually trigger idle agent detection for this org (admin only)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/routing-rules/idle-agent/run"

Empty

List all tags for the organization

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/tags"

Empty

Create a new tag

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/tags"

Empty

Get available tag color palette

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/tags/colors"

Empty

Delete a tag (cascade removes from conversations)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/tags/{id}"

Empty

Update a tag

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

curl -X put "https://loading/api/v1/tags/{id}"

Empty

Add a tag to a conversation

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/conversations/{conversationId}/tags"

Empty

Remove a tag from a conversation

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "https://loading/api/v1/conversations/{conversationId}/tags/{tagId}"

Empty

List teams

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

includeInactive?boolean

Defaultfalse

Response Body

curl -X get "https://loading/api/v1/teams"

Empty

Create a team (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description?string

color?string

icon?string

Response Body

curl -X post "https://loading/api/v1/teams" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Empty

Get team detail with members

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/teams/string"

Empty

Update team properties (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string

color?string

icon?string

isActive?boolean

routingStrategy?string

maxConversations?integer

offHoursBehavior?string

offHoursMessage?string

fallbackTeamId?string

Response Body

curl -X patch "https://loading/api/v1/teams/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Deactivate a team (soft delete, admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/teams/string"

Empty

Add a member to a team (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId*string

role?string

Default"MEMBER"

Value in"MEMBER" | "LEAD"

Response Body

curl -X post "https://loading/api/v1/teams/string/members" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

Empty

Update a team member's role (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

userId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in"MEMBER" | "LEAD"

Response Body

curl -X patch "https://loading/api/v1/teams/string/members/string" \  -H "Content-Type: application/json" \  -d '{    "role": "MEMBER"  }'

Empty

Remove a member from a team (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

userId*string

Response Body

curl -X delete "https://loading/api/v1/teams/string/members/string"

Empty

Get team schedule (working hours)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/teams/string/schedule"

Empty

Create or update team schedule (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

timezone*string

isEnabled?boolean

Defaulttrue

slots?array<>

Response Body

curl -X put "https://loading/api/v1/teams/string/schedule" \  -H "Content-Type: application/json" \  -d '{    "timezone": "string"  }'

Empty

Check if team is currently in working hours

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/teams/string/schedule/status"

Empty

Serve template header media file (image/video/document)

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/templates/string/header-media"

Empty

List approved WhatsApp templates

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/templates"

Empty

Create a WhatsApp template and submit to Meta for approval

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/templates"

Save a template locally as DRAFT without submitting to Meta

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

language?string

Default"es_MX"

category*string

Value in"MARKETING" | "UTILITY" | "AUTHENTICATION"

components*array<>

Response Body

curl -X post "https://loading/api/v1/templates/draft" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "category": "MARKETING",    "components": [      {}    ]  }'

Empty

Update a DRAFT template locally

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

language?string

category*string

Value in"MARKETING" | "UTILITY" | "AUTHENTICATION"

components*array<>

Response Body

curl -X put "https://loading/api/v1/templates/string/draft" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "category": "MARKETING",    "components": [      {}    ]  }'

Empty

Submit a DRAFT template to Meta for approval

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/templates/string/submit"

Empty

Soft-delete a template (mark as REMOVED)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/templates/string"

Empty

Edit a template's components in Meta and update in DB

Authorization

AuthorizationBearer <token>

In: header

curl -X put "https://loading/api/v1/templates/{id}"

Send a template message to a conversation

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

name*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conversationId*string

variables?array<string>

Response Body

curl -X post "https://loading/api/v1/templates/string/send" \  -H "Content-Type: application/json" \  -d '{    "conversationId": "string"  }'

Empty

Send a template message to an arbitrary phone number (creates or reuses conversation)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

name*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phone*string

Phone number with country code (digits only, e.g. 5214461234567)

variables?array<string>

Response Body

curl -X post "https://loading/api/v1/templates/string/send-to-phone" \  -H "Content-Type: application/json" \  -d '{    "phone": "string"  }'

Empty

Upload media for template header (returns file handle for Meta)

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/templates/upload-media"

Sync templates from WhatsApp Business API

Authorization

AuthorizationBearer <token>

In: header

curl -X post "https://loading/api/v1/templates/sync"

Duplicate a template as a DRAFT

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/templates/string/duplicate"

Empty

Delete template from Meta and mark as REMOVED in DB

Authorization

AuthorizationBearer <token>

In: header

curl -X delete "https://loading/api/v1/templates/{id}/meta"

Bulk actions on templates (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"delete"

selection*

Response Body

curl -X post "https://loading/api/v1/templates/bulk" \  -H "Content-Type: application/json" \  -d '{    "action": "delete",    "selection": {      "mode": "ids"    }  }'

Empty

List users (agents)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/users"

Empty

Create a new user (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

name*string

role?string

Value in"ADMIN" | "AGENT" | "VIEWER"

Response Body

curl -X post "https://loading/api/v1/users" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "name": "string"  }'

Empty

Update a user (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

email?string

Formatemail

role?string

Value in"ADMIN" | "AGENT" | "VIEWER"

Response Body

curl -X patch "https://loading/api/v1/users/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Soft-delete a user (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/users/string"

Empty

Resend invitation email to a user (admin only)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X post "https://loading/api/v1/users/string/resend-invite"

Empty

Update user online status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in"ONLINE" | "AWAY" | "OFFLINE"

Response Body

curl -X patch "https://loading/api/v1/users/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "ONLINE"  }'

Empty

Bulk actions on users (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"delete" | "changeRole"

selection*

params?

Response Body

curl -X post "https://loading/api/v1/users/bulk" \  -H "Content-Type: application/json" \  -d '{    "action": "delete",    "selection": {      "mode": "ids"    }  }'

Empty

Get Meta app configuration (appId + configId, no secret)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/whatsapp-accounts/meta-config"

Empty

Save Meta app configuration to DB

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

appId*string

appSecret?string

configId*string

Response Body

curl -X put "https://loading/api/v1/whatsapp-accounts/meta-config" \  -H "Content-Type: application/json" \  -d '{    "appId": "string",    "configId": "string"  }'

Empty

List connected WhatsApp Business accounts

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/whatsapp-accounts"

Empty

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code*string

Response Body

curl -X post "https://loading/api/v1/whatsapp-accounts/connect" \  -H "Content-Type: application/json" \  -d '{    "code": "string"  }'

Empty

Connect account with manually provided credentials

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

wabaId*string

phoneNumberId*string

accessToken*string

Response Body

curl -X post "https://loading/api/v1/whatsapp-accounts/connect-manual" \  -H "Content-Type: application/json" \  -d '{    "wabaId": "string",    "phoneNumberId": "string",    "accessToken": "string"  }'

Empty

Update account alias or access token

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alias?string|null

accessToken?string

Response Body

curl -X patch "https://loading/api/v1/whatsapp-accounts/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Disconnect a WhatsApp Business account

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/whatsapp-accounts/string"

Empty

Get live health and status info from Meta Graph API

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X get "https://loading/api/v1/whatsapp-accounts/string/health"

Empty

List account alerts for the current organization

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

acknowledged?string

Value in"true" | "false"

Response Body

curl -X get "https://loading/api/v1/whatsapp-accounts/alerts"

Empty

Count unacknowledged alerts

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/whatsapp-accounts/alerts/unread-count"

Empty

Mark an alert as acknowledged

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/whatsapp-accounts/alerts/{id}/acknowledge"

Empty

Mark all alerts as acknowledged

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X post "https://loading/api/v1/whatsapp-accounts/alerts/acknowledge-all"

Empty

Stream AI autocomplete suggestion for agent writing

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conversationId*string

partialText*string

Response Body

curl -X post "https://loading/api/v1/writing-assist/complete" \  -H "Content-Type: application/json" \  -d '{    "conversationId": "string",    "partialText": "string"  }'

Empty

Get writing assist config (org-level + user preference)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X get "https://loading/api/v1/config/writing-assist"

Empty

Update writing assist org config (admin only)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled?boolean

contextMessages?number

temperature?number

Response Body

curl -X put "https://loading/api/v1/config/writing-assist" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Toggle user writing assist preference

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

curl -X patch "https://loading/api/v1/profile/writing-assist" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

Empty

¿Esta página fue útil?

200

200

201

400

409

200

404

200

400

404

200

200

404

200

400

404

200

200

404

200

200

200

200

200

200

200

200

200

200

403

200

200

200

201

201

409

200

401

200

401

200

404

200