Sign in

v4

latestOpenAPI 3.1.02026-08-086635375.7 KB
Share Links

update share link

Update a share link by ID

put/v1/share-links/{id}

Path parameters

idstring uuid required

Share link ID

Request body

expiresInHoursnumber
usageLimitnumber

Response

Successfully updated share link

idstring uuid

Unique identifier for the share link.

tokenstring

Opaque token appended to the public URL.

type'LINK' | 'PLAYER_EMBED' | 'ORB_EMBED'

Kind of share link — a direct URL, a player embed, or an orb embed.

expiresAtstring date-time nullable

Timestamp after which the link no longer works, or null if the link does not expire.

usageLimitinteger nullable

Maximum number of times the link can be used, or null for unlimited.

usageCountinteger

Number of times the link has been used.

allowedOriginsstring[]

Origins permitted to load the link when embedded. Ignored when allowAllOrigins is true.

allowAllOriginsboolean

Whether the link can be embedded on any origin.

removeWatermarkboolean

Whether the persona renders without the Anam watermark. Requires a plan that permits watermark removal.

enabledboolean

Whether the link currently accepts connections.

isPrimaryboolean

Whether this is the persona's primary share link (at most one per persona).

createdAtstring date-time

Timestamp when the share link was created.