Getting started
Complete API documentation
Integrate Zyron Connect Suite with n8n, custom backends, external CRMs and internal jobs using versioned REST endpoints.
Overview
API v1 always operates inside the account that owns the key. Every read, write, update and send is scoped to the Bearer-authenticated user.
Base URL
Always use the complete URL below. The examples in this documentation are ready to copy.
https://connect.zyronstack.com/api/v1Authentication
Send the Authorization header on every request. Create the key in Dashboard > API. New keys can be revealed again after confirming the user's password.
Authorization: Bearer SUA_CHAVE_APIRate limit
The limit is per key and per plan: 120 requests per minute on the Basic and Official plans, 300 on Agency. When exceeded, the API returns HTTP 429 with the Retry-After header.
Pagination
List endpoints accept limit and offset. The response includes pagination.limit, pagination.offset, pagination.total and pagination.next_offset.
OpenAPI JSON
GET https://connect.zyronstack.com/api/v1/openapi.json
OpenAPI JSONMonte seus exemplos
Cole os valores da sua conta uma vez
Os exemplos não usam UUIDs fictícios: onde faltar um valor, aparece <NOME_DO_VALOR>. A chave fica só na memória deste navegador.
Identifique a conexão
Use o número da instância direto, ou copie connection_id em GET /connections.
Envie ou faça upload
Cada tipo tem sua rota: /messages/text, /media, /template ou /interactive.
Acompanhe a entrega
O 202 apenas aceita; consulte o status pelo wamid.
Baixe mídia recebida
Leia a mensagem, consulte GET /media/:id e chame a URL de download.
Getting started
Errors
Failures return standardized JSON with error.code and error.message.
| 400 invalid_body / query_error | invalid JSON or query failure |
| 401 unauthorized | missing, invalid or revoked key |
| 403 forbidden | key lacks the required scope |
| 403 upgrade_required | feature requires the Official or Agency plan |
| 404 not_found | resource not found in the authenticated account |
| 422 validation | missing required field or invalid value |
| 429 rate_limited | exceptional abuse protection |
{ "error": { "code": "unauthorized", "message": "Chave de API ausente ou inválida." } }Module
Modules
Explore endpoints by product area, with ready-to-use examples for each operation.