# Alcances (`scopes`) de las claves de API

> Generado desde `openapi/openapi.yaml`. `pnpm docs:gen`.

Una clave solo puede llamar a las operaciones cuyo alcance incluye. Crea claves con el mínimo necesario.

| Alcance | Operaciones |
| --- | --- |
| `agents:write` | `GET /v1/agents`<br>`POST /v1/agents`<br>`PATCH /v1/agents/{agent_id}` |
| `contacts:write` | `GET /v1/contacts`<br>`POST /v1/contacts`<br>`GET /v1/contacts/{contact_id}`<br>`PATCH /v1/contacts/{contact_id}`<br>`DELETE /v1/contacts/{contact_id}`<br>`POST /v1/contacts/{contact_id}/opt-in`<br>`POST /v1/contacts/{contact_id}/opt-out` |
| `conversations:read` | `GET /v1/conversations`<br>`GET /v1/conversations/{conversation_id}`<br>`GET /v1/conversations/{conversation_id}/messages` |
| `conversations:write` | `POST /v1/messages/{message_id}/redact`<br>`PATCH /v1/conversations/{conversation_id}`<br>`POST /v1/conversations/{conversation_id}/messages`<br>`POST /v1/conversations/{conversation_id}/read`<br>`GET /v1/conversations/{conversation_id}/notes`<br>`POST /v1/conversations/{conversation_id}/notes` |
| `embed:create` | `POST /v1/embed/tokens` |
| `keys:write` | `GET /v1/api-keys`<br>`POST /v1/api-keys`<br>`DELETE /v1/api-keys/{key_id}` |
| `messages:read` | `GET /v1/messages`<br>`GET /v1/messages/{message_id}`<br>`GET /v1/media/{media_id}` |
| `messages:send` | `POST /v1/messages`<br>`POST /v1/messages/{message_id}/typing`<br>`POST /v1/messages/{message_id}/retry`<br>`POST /v1/media` |
| `numbers:read` | `GET /v1/whatsapp/account`<br>`GET /v1/numbers`<br>`GET /v1/numbers/{number_id}`<br>`GET /v1/whatsapp/signup-sessions/{session_id}` |
| `numbers:write` | `PATCH /v1/numbers/{number_id}`<br>`DELETE /v1/numbers/{number_id}`<br>`POST /v1/numbers/{number_id}/refresh`<br>`POST /v1/whatsapp/signup-sessions`<br>`POST /v1/whatsapp/signup-sessions/{session_id}/complete` |
| `settings:write` | `GET /v1/settings`<br>`PATCH /v1/settings` |
| `templates:read` | `GET /v1/templates`<br>`GET /v1/templates/{template_id}`<br>`POST /v1/templates/{template_id}/preview`<br>`GET /v1/template-library` |
| `templates:write` | `POST /v1/templates`<br>`POST /v1/templates/sync`<br>`PATCH /v1/templates/{template_id}`<br>`DELETE /v1/templates/{template_id}`<br>`POST /v1/templates/{template_id}/submit`<br>`POST /v1/template-library/{code}/activate` |
| `usage:read` | `GET /v1/usage/costs`<br>`GET /v1/usage/messages`<br>`GET /v1/license` |
| `webhooks:write` | `GET /v1/webhook-subscriptions`<br>`POST /v1/webhook-subscriptions`<br>`PATCH /v1/webhook-subscriptions/{subscription_id}`<br>`DELETE /v1/webhook-subscriptions/{subscription_id}`<br>`POST /v1/webhook-subscriptions/{subscription_id}/test`<br>`GET /v1/webhook-deliveries`<br>`POST /v1/webhook-deliveries/{delivery_id}/redeliver` |

## Roles de las pantallas embebidas

| Rol | Puede |
| --- | --- |
| `agent` | Chat (sus conversaciones y las sin asignar), ver plantillas |
| `supervisor` | Todo lo anterior, ver todas las conversaciones, reasignar, ver agentes y uso |
| `admin` | Todo, incluidas plantillas, números, agentes, claves, eventos y ajustes |

Una clave de API actúa con rol `admin`; sus límites son los alcances.