Skip to main content
PUT
/
v1
/
share-links
/
{id}
update share link
curl --request PUT \
  --url https://api.anam.ai/v1/share-links/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usageLimit": 50
}
'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "token": "sh_2kL9pQxYzR4vN8mBwHfJc",
  "type": "LINK",
  "expiresAt": "2026-04-27T10:00:00.000Z",
  "usageLimit": 10,
  "usageCount": 0,
  "allowedOrigins": [],
  "allowAllOrigins": false,
  "removeWatermark": false,
  "enabled": true,
  "isPrimary": false,
  "createdAt": "2026-04-20T10:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Share link ID

Body

application/json

Fields to update on the share link. Omit a field to leave it unchanged.

​
expiresInHours
number
​
usageLimit
number

Response

Successfully updated share link

A shareable link to a persona. Can be used as a direct URL or embedded via the widget.

​
id
string<uuid>

Unique identifier for the share link.

​
token
string

Opaque token appended to the public URL.

​
type
enum<string>

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

Available options:
LINK,
PLAYER_EMBED,
ORB_EMBED
​
expiresAt
string<date-time> | null

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

​
usageLimit
integer | null

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

​
usageCount
integer

Number of times the link has been used.

​
allowedOrigins
string[]

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

​
allowAllOrigins
boolean

Whether the link can be embedded on any origin.

​
removeWatermark
boolean

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

​
enabled
boolean

Whether the link currently accepts connections.

​
isPrimary
boolean

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

​
createdAt
string<date-time>

Timestamp when the share link was created.

Last modified on April 22, 2026