canonical: https://jentic.com/apis/whatsapp.local/whatsapp-local

# WhatsApp Business API

See https://developers.facebook.com/docs/whatsapp. The API exposes 55 endpoints secured with basic, bearer authentication.

## For AI agents

Programmatically login-user, create-user. Covers 55 operations with basic, bearer authentication.

## Scope

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

## Capabilities

- Login-User
- Create-User
- Get-User
- Update-User
- Delete-User
- Logout-User
- Get-Application-Settings

## Use cases

### Developer Tools Operations

Use the WhatsApp Business API to perform developer tools operations programmatically. The API provides 55 endpoints covering core functionality including login-user, create-user, get-user.

Example prompt: Call POST `/users/login` to login-user

### Automated Users Management

Automate users operations by combining multiple WhatsApp Business API endpoints. Agents can create-user and then get-user in a single workflow.

Example prompt: Call POST /users to create-user, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call WhatsApp Business API 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 basic, bearer tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/users/login` | Login-User |
| POST | `/users` | Create-User |
| GET | `/users/{UserUsername}` | Get-User |
| PUT | `/users/{UserUsername}` | Update-User |
| DELETE | `/users/{UserUsername}` | Delete-User |
| POST | `/users/logout` | Logout-User |
| GET | `/settings/application` | Get-Application-Settings |
| PATCH | `/settings/application` | Update-Application-Settings |

## Key resources

- **Users** — Operations related to Users
- **Application** — Operations related to Application
- **Backup/Restore** — Operations related to Backup/Restore
- **Business Profile** — Operations related to Business Profile
- **Profile** — Operations related to Profile

## 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:** 36 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 48 / 100
  - Developer Experience & Jentic Compatibility: 60 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 93 / 100
  - Security: 35 / 100
  - AI Discoverability: 9 / 100
- **View full report:** https://jentic.com/apis/whatsapp.local/whatsapp-local/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 the WhatsApp Business API by hand means choosing between its basic auth and bearer token per call and handling retries yourself across its user and settings surface. Through Jentic you install once, import the WhatsApp Business API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The WhatsApp Business API puts the username in the URL path (`/users/{UserUsername}`), so a rule can pin your agent to reading one user: it can fetch that user and nothing else. You choose the operations it may call, so destructive ones like updating or deleting a user are not included unless you add them.
- **Credential handling:** Your WhatsApp Business API basic and bearer credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'log in a user' or 'read application settings', and Jentic returns the matching WhatsApp Business API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the WhatsApp Business API use?

The WhatsApp Business API uses basic, bearer authentication. 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 login-user with the WhatsApp Business API?

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

### What are the rate limits for the WhatsApp Business API?

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 login-user through Jentic?

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

### How many endpoints does the WhatsApp Business API have?

The WhatsApp Business API exposes 55 endpoints covering users, application, backup/restore operations.

### Can I limit what my agent is allowed to do with the WhatsApp Business API?

Yes. Because you self-host Jentic One, your own rules decide which WhatsApp Business API operations and credentials the agent may use. Since the username lives in the URL path (`/users/{UserUsername}`), you can pin the agent to reading a single user with GET `/users/{UserUsername}` and nothing else. You choose the operations it may call, so destructive ones like PUT or DELETE `/users/{UserUsername}` are excluded unless you add them.