Skip to main content
PATCH
/
pause
Pause URL
curl --request PATCH \
  --url https://api.example.com/pause
{
  "message": "<string>"
}
This endpoint pauses a short URL by setting its url_state to false. While paused, the short URL will return a 423 (Locked) error instead of redirecting to the destination URL.
This endpoint requires authentication. Include a valid Bearer token in the Authorization header.

​
Authentication

This endpoint uses HTTPBearer security. Include the access token obtained from the /login endpoint: 
Authorization: Bearer <access_token>
The URL code is automatically extracted from the authenticated token, so no additional parameters are required.

​
Response

​
message
string
Success message confirming the URL has been paused

​
Status Codes

  • 200: URL successfully paused
  • 404: URL not found
  • 403: Invalid or expired token

​
Behavior

When a URL is paused:
  • The short URL will return HTTP 423 (Locked) with the message “Redirect temporarily paused”
  • Hit counts will not increment for paused URLs
  • The URL can be resumed at any time using the /resume endpoint
curl -X PATCH https://api.example.com/pause \
  -H "Authorization: Bearer <access_token>"

Build docs developers (and LLMs) love

Get started for freeTalk to us