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

reasonstring nullable

Why the key paused itself (max 200 chars); shown in the dashboard

Response

Paused

api_key_idstring

ID of the key that was paused

pausedboolean

Always true on success

paused_atstring

When the pause took effect (ISO8601 UTC)

reasonstring nullable

The reason as stored

resumestring

How the key is resumed

Changes

No recorded changes to this operation across all 1 revision of this API.