API Reference
OIDC
Platform

Sms Templates

AdminUpdated Sep 11, 2026

Sms Templates

Backend API — secret key (Authorization: Bearer sk_…).

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

Method & path

Scope

Idem

Explanation

GET /v1/sms_templates

sms_templates:read

List SMS templates with their built-in defaults and any instance override.

POST /v1/sms_templates

sms_templates:write

Set an SMS body template. A body dropping the code placeholder is refused.

GET /v1/sms_templates/:name

sms_templates:read

Read one SMS template: its built-in default and the instance override.

PATCH /v1/sms_templates/:name

sms_templates:write

Update an SMS template body or its enabled flag. Re-validated on save.

DELETE /v1/sms_templates/:name

sms_templates:write

Revert an SMS template to the Atlas built-in default body.

POST /v1/sms_templates/:name/preview

sms_templates:read

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

Was this page helpful?