CX Bot & Inbox API

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

Overview KPIs and charts (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

force?string

Value intrue | false

excludeIncomplete?string

Value intrue | false

Response Body

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

Empty

Conversation volume, response times, categories (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

force?string

Value intrue | false

excludeIncomplete?string

Value intrue | false

Response Body

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

Empty

Per-agent performance metrics (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

force?string

Value intrue | false

Response Body

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

Empty

Bot performance metrics (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

force?string

Value intrue | false

Response Body

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

Empty

Campaign delivery funnel and costs (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

timezone?string

Default"America/Mexico_City"

force?string

Value intrue | false

Response Body

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

Empty

List API keys for the organization (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

Empty

Create a new API key (requiere rol Admin). 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 (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

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

Delete an API key permanently (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

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

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

type?string

Default"BROADCAST"

Value in"BROADCAST" | "SURVEY"

surveyConfig?object

Required when type=SURVEY

batchSize?integer

batchPauseSeconds?integer

autoPauseOnQualityDrop?boolean

inboxCategory?string|null

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

List all campaigns

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

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

Get WhatsApp phone number status and quality rating (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

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

Get paginated survey responses for a SURVEY campaign (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

page?integer

Default1

pageSize?integer

Default50

Response Body

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

Empty

Export survey responses as CSV for a SURVEY campaign (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`text/csv`

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

"string"

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/category (on conversations) and/or lightweight profile (alias/notes/customFields)

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

alias?string|null

notes?string|null

customFields?|null

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

searchInMessages?boolean

When true, search also matches message bodies (not just contact)

cursor?string

limit?integer

Default50

teamId?string

category?string

origin?string

followUp?boolean

When true, only conversations flagged for follow-up

windowExpiresWithin?integer

Filter to conversations whose 24h window expires within N minutes

tagIds?string

Comma-separated tag IDs to filter by

subFilter?string

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

Value in"unread" | "needs_action" | "needs_action_window_open"

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

Distinct categories with conversation counts (ADMIN) — raw values, for the merge tool

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

Empty

Merge near-duplicate categories into a canonical one (ADMIN)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sources*array<string>

target*string

Response Body

curl -X post "https://loading/api/v1/conversations/categories/merge" \  -H "Content-Type: application/json" \  -d '{    "sources": [      "string"    ],    "target": "string"  }'

Empty

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

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

status?string

assignedTo?string

search?string

teamId?string

category?string

origin?string

followUp?boolean

windowExpiresWithin?integer

Response Body

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

Empty

Bulk re-classify and re-route open conversations (ADMIN)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

scope*string

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

Response Body

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

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

Path Parameters

id*string

Response Body

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

Empty

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status?string

assignedUserId?string|null

priority?string

subject?string

category?string|null

teamId?string|null

Response Body

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

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

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/conversations/string/assign" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

Empty

Unassign conversation (release it for other agents)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Resolve conversation (mark as resolved)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Check whether a closed/resolved conversation can be reopened

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Reopen a closed/resolved conversation

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Mark conversation for follow-up

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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/string/follow-up" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Remove follow-up from conversation

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X delete "https://loading/api/v1/conversations/string/follow-up"

Empty

Get sibling conversations metadata for the same contact (cross-conversation history)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Get aggregated contact history (other conversations from the same contact)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

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

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" | "internal_note"

body?string

templateName?string

templateLanguage?string

templateComponents?array<>

buttons?array<>

replyToMessageId?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

Emoji to react with (empty string removes the reaction)

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 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 (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

shortcut*string

Length2 <= length <= 50

label*string

Length1 <= length <= 50

text*string

Length1 <= length <= 2000

sortOrder?integer

Default0

Response Body

curl -X post "https://loading/api/v1/quick-replies" \  -H "Content-Type: application/json" \  -d '{    "shortcut": "string",    "label": "string",    "text": "string"  }'

Empty

List all quick replies including inactive (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

Empty

Update a quick reply (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

shortcut?string

Length2 <= length <= 50

label?string

Length1 <= length <= 50

text?string

Length1 <= length <= 2000

sortOrder?integer

isActive?boolean

Response Body

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

Empty

Delete a quick reply (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Bulk actions on quick replies (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

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

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

Update a tag

Authorization

AuthorizationBearer <token>

In: header

Response Body

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

Empty

Delete a tag (cascade removes from conversations)

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X delete "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 (requiere rol Admin)

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 (requiere rol Admin)

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, requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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

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<>

headerMediaPath?string

surveyOptions?array<string>

folder?string|null

inboxCategory?string|null

Response Body

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

Empty

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

Assign or change a template's folder (local metadata, requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

folder*string|null

Response Body

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

Empty

Set or change a template's default inbox category (local metadata, requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

inboxCategory*string|null

Response Body

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

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

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

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" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "category": "MARKETING",    "components": [      {}    ]  }'

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

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. 525512345678)

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

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*string

headerType*string

Value in"IMAGE" | "VIDEO" | "DOCUMENT"

Response Body

curl -X post "https://loading/api/v1/templates/upload-media" \  -F file="string" \  -F headerType="IMAGE"

Empty

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 (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

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

Empty

Bulk actions on templates (requiere rol Admin)

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"delete" | "move_to_folder"

selection*

folder?|

Target folder for move_to_folder action. Empty/null groups under "Sin carpeta".

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 (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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 (requiere rol Admin)

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

¿Esta página fue útil?

200

200

200

200

200

200

201

201

400

404

200

200

200

200

404

200

404

200

200text/csv

404

200

404

200

404

200

200

400

404

200text/csv

400

404

200

200

200

403

200

200

200

200

`text/csv`

`text/csv`