telephony

Revoke Event Share Link

Kill one clip link. The recipient's next load is the same 404 an unknown token gets.

IDEMPOTENT: an already-revoked link answers 200 with the UNCHANGED first revoker and first timestamp. A second revoke must not rewrite the audit, and a client retrying a click must not see an error for a link that is already dead.

A link id belonging to ANOTHER event is the same 404 as one that does not exist — this route must not confirm the existence of link ids outside the event the caller can already reach.

A FAILED SEND DOES NOT AUTO-REVOKE ITS LINK, and this route is why. A provider failure is often AMBIGUOUS (the network died; Surge may well have sent it), so the customer may already hold the URL and revoking would break a message that did arrive. The operator sees the failed row with its link and decides.

post/events/{event_id}/share-links/{link_id}/revoke

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/events/{event_id}/share-links/{link_id}/revoke
  • Auth
    HTTP bearer

Path parameters

event_idstring required
link_idstring required

Response

Successful Response

idstring required

The share link id.

created_atstring date-time nullable

When it was minted.

created_by_namestring nullable

The operator who sent the message that minted it. Operator-only; never customer-facing.

expires_atstring date-time nullable

When it stops working.

revoked_atstring date-time nullable

When an operator killed it. Write-once: a second revoke returns this value unchanged rather than rewriting the audit.

first_viewed_atstring date-time nullable

First time the page was served. Null means never opened.

last_viewed_atstring date-time nullable

Most recent time the page was served.

view_countinteger required

How many times the page was served. Counters and timestamps only -- no IP, no user agent: there is no consent basis for tracking a property owner's device.

notification_log_idstring nullable

The incident-timeline row this link was minted with.

sms_message_idstring nullable

The thread message this link was minted with.

Changes

No recorded changes to this operation across all 2 revisions of this API.