{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-v3/openapi.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"v3/openapi.yaml","dynamicMarkdocComponents":[],"baseSlug":"/v3/openapi","seo":{"title":"Sintalk API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Sintalk API","description":"The Sintalk API lets you send SMS, RCS, and voice notifications, manage\nthe templates and contact lists those notifications use, run bulk\ncampaigns, and read back delivery and billing data.\n\n## Getting started\n\n1. Create an API key from the dashboard or via `POST /api-keys`.\n2. Authenticate every request with `X-API-Key: <your key>` (or\n   `Authorization: Bearer <your key>`).\n3. Create a template (`POST /templates`), then either send ad-hoc\n   notifications with `POST /send` or launch a campaign against a\n   contact list.\n\n## Conventions\n\n- **IDs** are UUIDv7 strings (time-ordered).\n- **Timestamps** are RFC 3339 in UTC unless a query parameter says\n  otherwise.\n- **Phone numbers** use E.164 format (e.g. `+5511999999999`).\n- **Monetary amounts** are returned in *micro-units* (1 BRL = 1,000,000\n  micro-units). This keeps balances and per-message costs exact.\n- **Pagination** is offset-based — pass `limit` and `offset`, read\n  `total` and `has_more` from the response.\n- **Errors** always include a stable `error_code` you can branch on,\n  plus an optional human-readable `error` message."},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.sintalk.com.br","port":4000,"ipAddress":"216.73.216.101"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/v3/openapi","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}