---
title: "Pause the calling API key so it stops authenticating until a workspace owner resumes it in the dashboard"
method: POST
path: "/v2/auth/api-keys/self/pause"
tags: ["auth-v2"]
---

# 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`

## Request

- Base URL: `https://api.tracklysms.com/api`
- URL: `https://api.tracklysms.com/api/v2/auth/api-keys/self/pause`
- Auth: API key in header `X-Api-Key`

## Request body

- PauseApiKeyRequest
  - `reason` string, nullable: Why the key paused itself (max 200 chars); shown in the dashboard

## Response `200`

Paused

- PauseApiKeyResponse
  - `api_key_id` string: ID of the key that was paused
  - `paused` boolean: Always true on success
  - `paused_at` string: When the pause took effect (ISO8601 UTC)
  - `reason` string, nullable: The reason as stored
  - `resume` string: How the key is resumed

## Other responses

- `400`: Invalid payload
- `401`: Invalid credentials
- `409`: Credential changed before the pause

---

[API](https://skmtc.dev/tracklysms/apis/trackly-sms-api.md) · [All operations](https://skmtc.dev/tracklysms/apis/trackly-sms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tracklysms/apis/trackly-sms-api/revisions/ac1ad22cb2a9?raw)