API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Sms Templates

AdminUpdated Sep 11, 2026

Sms Templates

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

6 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates

The per-instance SMS templates — built-in default alongside any override.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates

Customise an SMS template body (upsert). Must keep {{code}}. Owner or admin.

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates/:name

One SMS template — its built-in default and stored override, if any.

PATCH /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates/:name

Edit an SMS template body/enabled. Owner or admin.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates/:name

Reset an SMS template to the built-in default (drops the override). Owner or admin.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/sms_templates/:name/preview

Render an SMS body with a fixed sample code — never a live OTP.

Was this page helpful?
Sms Templates