curl -X POST https://api.tracklysms.com/api/v2/auth/api-keys/self/pause \
-H "X-Api-Key: trk_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "reason": "sandbox response missing sandbox=true; halting until reviewed" }'
{
"paused": true,
"api_key_id": "66f1c2a9b8e4d3f0a1b2c3d4",
"paused_at": "2026-09-03T19:02:11Z",
"reason": "sandbox response missing sandbox=true; halting until reviewed",
"resume": "A workspace owner can resume this key from Settings > API Keys in the dashboard."
}
{ "error": "Invalid credentials", "code": "invalid_credentials" }
V2 API Reference
Pause Own Key
Pause the calling API key so it stops authenticating until a workspace owner resumes it in the dashboard.
POST
/
v2
/
auth
/
api-keys
/
self
/
pause
curl -X POST https://api.tracklysms.com/api/v2/auth/api-keys/self/pause \
-H "X-Api-Key: trk_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "reason": "sandbox response missing sandbox=true; halting until reviewed" }'
{
"paused": true,
"api_key_id": "66f1c2a9b8e4d3f0a1b2c3d4",
"paused_at": "2026-09-03T19:02:11Z",
"reason": "sandbox response missing sandbox=true; halting until reviewed",
"resume": "A workspace owner can resume this key from Settings > API Keys in the dashboard."
}
{ "error": "Invalid credentials", "code": "invalid_credentials" }
A kill switch for an integration that decides it should stop. The calling key moves to
paused immediately: subsequent API requests with it, including a second pause, fail authentication with 401 invalid_credentials. It also stops authenticating on other surfaces, including SMTP. Only a workspace owner can resume the key, from Settings → API Keys in the dashboard; the key itself cannot undo the pause.
Use it from an AI agent or automation when something looks wrong: an unexpected response, a suspected prompt injection, a runaway loop. It pauses only the calling credential; other keys, including a rotated replacement, remain unchanged. Pausing does not cancel messages already queued or stop existing schedules.
Body Parameters
The body is optional: send none to pause without a reason. When a body is sent it must be a JSON object; an invalid body leaves the key unchanged.string
Why the key paused itself, at most 200 characters. Stored with the key and shown in the dashboard. Omitted,
null, or blank reasons are stored and echoed as null. Activity logs record whether a reason was supplied, without copying its text.Response Fields
boolean
Always
true.string
ID of the key that was paused.
string
When the pause took effect (ISO-8601, UTC).
string
The stored reason, or
null.string
How the key is resumed.
Errors
| HTTP Status | Error Code | Description |
|---|---|---|
| 400 | invalid_payload | A body was sent that is not a JSON object, or a non-null reason is not a string or exceeds 200 characters. Nothing is paused. |
| 401 | invalid_credentials | The key is missing, unknown, revoked, or already paused. |
| 409 | key_not_active | The key changed state while this request ran; nothing was changed. Reload its state before retrying. |
Resuming in the Dashboard
The owner must review the current pause and key settings before resuming. Their owner access and any required session verification must remain current. If those settings change after the page loads, reload and review them again. Keys with Voice permissions also require a second factor enrolled and verified in the owner’s current session, and their Voice approval must remain current. A rotated key can pause during its grace window. Resuming preserves the original grace deadline; it does not extend it. If that deadline passes while the key is paused, resuming leaves it revoked.Examples
curl -X POST https://api.tracklysms.com/api/v2/auth/api-keys/self/pause \
-H "X-Api-Key: trk_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "reason": "sandbox response missing sandbox=true; halting until reviewed" }'
{
"paused": true,
"api_key_id": "66f1c2a9b8e4d3f0a1b2c3d4",
"paused_at": "2026-09-03T19:02:11Z",
"reason": "sandbox response missing sandbox=true; halting until reviewed",
"resume": "A workspace owner can resume this key from Settings > API Keys in the dashboard."
}
{ "error": "Invalid credentials", "code": "invalid_credentials" }