canonical: https://jentic.com/apis/zenvia.io/zenvia

# Zenvia APIs

API Support: https://atendimento.zenvia.com/ Overview This is the reference documentation for the Zenvia REST-like API. The API exposes 18 endpoints secured with apiKey authentication.

## For AI agents

Programmatically sendfacebookmessage, sendsmsmessage. Covers 18 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- sendFacebookMessage
- sendSmsMessage
- sendWhatsappMessage
- createSubscription
- listSubscriptions
- getSubscription
- updateSubscription

## Use cases

### CRM Operations

Use the Zenvia APIs to perform crm operations programmatically. The API provides 18 endpoints covering core functionality including sendfacebookmessage, sendsmsmessage, sendwhatsappmessage.

Example prompt: Call POST `/channels/facebook/messages` to sendfacebookmessage

### Automated SMS Management

Automate sms operations by combining multiple Zenvia APIs endpoints. Agents can sendsmsmessage and then sendwhatsappmessage in a single workflow.

Example prompt: Call POST `/channels/sms/messages` to sendsmsmessage, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Zenvia APIs endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'sendfacebookmessage', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/channels/facebook/messages` | sendFacebookMessage |
| POST | `/channels/sms/messages` | sendSmsMessage |
| POST | `/channels/whatsapp/messages` | sendWhatsappMessage |
| POST | `/subscriptions` | createSubscription |
| GET | `/subscriptions` | listSubscriptions |
| GET | `/subscriptions/{subscriptionId}` | getSubscription |
| PATCH | `/subscriptions/{subscriptionId}` | updateSubscription |
| DELETE | `/subscriptions/{subscriptionId}` | deleteSubscription |

## Key resources

- **SMS** — The SMS channel may be used after its activation on Zenvia platform.
- **WhatsApp** — The WhatsApp channel may be used after its activation on Zenvia platform.
- **Facebook** — The Facebook channel may be used after connection on Zenvia platform.
- **Webhooks** — Webhooks allow you to receive events in the configured URL.
- **Templates** — Message Templates are message formats for common reusable messages.

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 40 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/zenvia.io/zenvia/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Zenvia APIs by hand means setting its TOKEN header on every request, coding separate handling for the Facebook, SMS, and WhatsApp channels on api.zenvia.com/v1, and wiring subscriptions yourself. Through Jentic you install once, import Zenvia from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Zenvia carries the message channel and content in the request body rather than as a target in the URL path, so limit the agent to the operations it needs, such as sending an SMS or a WhatsApp message. You leave out subscription deletion unless the agent is meant to manage webhooks.
- **Credential handling:** Your Zenvia token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a WhatsApp message' or 'list webhook subscriptions', and Jentic returns the matching Zenvia operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Zenvia APIs use?

The Zenvia APIs uses an API key passed in the `JWT` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I sendfacebookmessage with the Zenvia APIs?

Yes. Use the POST `/channels/facebook/messages` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Zenvia APIs?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I sendfacebookmessage through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'sendfacebookmessage'. Jentic returns the matching Zenvia APIs operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Zenvia APIs have?

The Zenvia APIs exposes 18 endpoints covering sms, whatsapp, facebook operations.

### Can I limit what my agent is allowed to do with the Zenvia APIs?

Yes. Because you run Jentic One yourself, your own rules decide which Zenvia operations and credentials the agent may use. Zenvia carries the message channel and content in the request body rather than in the URL path, so you can scope the agent to just the operations it needs, such as sending an SMS or a WhatsApp message, and leave out subscription deletion unless it is meant to manage webhooks. Your Zenvia token is injected at execution time and only for the calls you have allowed.