Turn off a share link

POST
/v1/share-links/{linkId}/revoke

Turns a link off for good. Anyone using it stops right away, including a call that is running, and anyone who opens it afterwards is told it was turned off. It cannot be turned back on: make another link. Any member of the workspace, or a key with the share_links:write scope, may. Turning off a link that is already off answers the same.

Requires an API key with the share_links:write scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Path Parameters

linkId*string

The share link id, from the list or from the answer that made it.

Response Body

The link, turned off

application/json
  1. response
link*

The link, turned off.

Example Request
curl -X POST "https://api.vlayers.ai/v1/share-links/$SHARE_LINK_ID/revoke" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "link": {    "id": "grt_0192f5e1a2b37c4d8e5f6a7b8c9d0e1f",    "agentId": "0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",    "state": "revoked",    "title": "Books team test",    "displayName": "Acme Books",    "target": "live",    "sealedVersionLabel": "Published version of Nov 8",    "sealedAt": "2026-11-08T15:12:00.000Z",    "privacyUrl": "https://acmebooks.example/privacy",    "limits": {      "conversations": 20,      "voiceMinutes": 60,      "dollarsMicros": 10000000,      "atOnce": 2,      "callMinutes": 5,      "typedMessages": 40,      "typedDollarsMicros": 1000000,      "perAddressPerDay": 5,      "perAddressPerHour": 3    },    "expiresAt": "2026-11-15T15:12:00.000Z",    "tools": {      "off": [        "refund_order",        "vl_send_text"      ]    },    "usage": {      "conversations": 3,      "minutes": 12.5,      "spentMicros": 1500000    },    "lastUsedAt": "2026-11-09T09:30:00.000Z",    "revokedBy": "user_2abc",    "revokedAt": "2026-11-09T10:00:00.000Z",    "createdBy": "user_2abc",    "createdAt": "2026-11-08T15:12:00.000Z",    "updatedAt": "2026-11-08T15:12:00.000Z",    "version": 4  }}