Skip to main content
PATCH
Update a share link

Authorizations

Authorization
string
header
required

Enter your API key (Bearer token)

Path Parameters

agent_id
string
required

The agent the link opens a call with.

The id of the link.

Body

application/json
enabled
boolean

false pauses the link and ends any call running through it; true turns it back on. Sending expires_in restarts the clock from now.

Example:

false

expires_in
enum<string>

How long the link works. Defaults to 7d.

Available options:
1d,
7d,
30d,
never
Example:

"7d"

label
string

A note for you, for example who the link is for. Up to 120 characters.

Maximum string length: 120
Example:

"Demo for Dr Rao's clinic"

Response

agent_id
string
required
Example:

"0b6f3c1a-2d4e-4f5a-8b9c-1d2e3f4a5b6c"

call_count
number
required

Calls started through this link so far.

Example:

3

created_at
string<date-time>
required
Example:

"2026-10-19T10:00:00.000Z"

enabled
boolean
required

false while the link is paused.

Example:

true

expires_at
string<date-time> | null
required

When the link stops working. null means it never expires.

Example:

"2026-10-26T10:00:00.000Z"

id
string
required
Example:

"6d1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b"

label
string | null
required
Example:

"Demo for Dr Rao's clinic"

status
enum<string>
required

active: works now. disabled: paused. expired: past expires_at. revoked: turned off for good.

Available options:
active,
disabled,
expired,
revoked
Example:

"active"

url
string | null
required

The link to send. Anyone who opens it can talk to the agent in their browser. null only for a link made before a security key change: it still works for whoever has it, but cannot be shown again. Replace it to get a new one.

Example:

"https://brilo.ai/talk#q3Vx9mT2bK7yR1nW8pZ4cL6hJ0dF5sA2gE9uY3iO7kM"