Skip to main content
POST
/
shared-links
Create shared link
curl --request POST \
  --url https://api.goyappr.com/shared-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "<string>",
  "url": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "is_revoked": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

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>