Made in 10Docs
GuidesAPI
ReferenceLinks

Revoke a link

It stops opening a call at once; a call already running goes on.

POST
/links/{link_id}/revoke

Authorization

secretKey
headerAuthorizationBearer <sk_live_… or sk_test_… (a prefix and 40 base62 characters)>

A secret key from the dashboard, sent as Authorization: Bearer sk_live_…. Live keys run real, charged calls; test keys (sk_test_…) run calls of at most 60 seconds, 20 a day per organization, never charged. Each key sees only its own env's calls, meetings, webhooks, memories and analytics. Publishable keys (pk_…) are refused.

Path Parameters

Response Body

The link as it is now.

application/json
  1. response
id*string
Example"lnk_8Hq2Lm5VtR9xPc3NwZ7k"
url*|

The person's address.

Formaturi
character_id*CharacterId

A character's id.

Match^chr_[0-9A-Za-z]{20}$
Example"chr_4fT9kQ2mXw7LbN3pZs8V"
env*string
Value in"live""test"
status*LinkStatus
Value in"unused""started""completed""expired""revoked"
name?string
email?string
external_id?string
context?string
variables?
language?string|null
memory_key?string|null
metadata?
max_uses*integer
uses*integer

Attempts begun.

resume_minutes*integer
resume_until_unix?|

Until when a dropped call can come back.

expires_unix?integer|null
opened_unix?integer|null
consented_unix?|

When the notice was last accepted.

completed_unix?integer|null
revoked_unix?integer|null
created_unix*integer
last_call_id?string|null
in_call?boolean
calls?array<>

getLink only: its calls, oldest first.

Example Request
curl -X POST 'https://api.daxov.com/v1/links/string/revoke'
Example Response
{  "id": "lnk_8Hq2Lm5VtR9xPc3NwZ7k",  "url": "http://example.com",  "character_id": "chr_4fT9kQ2mXw7LbN3pZs8V",  "env": "live",  "status": "unused",  "name": "string",  "email": "string",  "external_id": "string",  "context": "string",  "variables": {    "property1": "string",    "property2": "string"  },  "language": "string",  "memory_key": "string",  "metadata": {},  "max_uses": 0,  "uses": 0,  "resume_minutes": 0,  "resume_until_unix": 0,  "expires_unix": 0,  "opened_unix": 0,  "consented_unix": 0,  "completed_unix": 0,  "revoked_unix": 0,  "created_unix": 0,  "last_call_id": "string",  "in_call": true,  "calls": [    {      "id": "call_2Gx7Mb9KpQ4sVn1ZrT6e",      "resumed": true,      "end_reason": "string",      "settled_unix": 0,      "created_unix": 0    }  ]}