Skip to main content
POST
Create shared link

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
agent_id
string<uuid>
required

Agent to create a share link for

expires_at
string<date-time> | null

When the link expires. Omit or null for never.

Response

Created shared link

id
string<uuid>
token
string
url
string

Full shareable URL

agent_id
string<uuid>
company_id
string<uuid>
created_by
string<uuid> | null
expires_at
string<date-time> | null
is_revoked
boolean
status
enum<string>
Available options:
active,
expired,
revoked
created_at
string<date-time>