Skip to main content
POST
/
accounts
/
{account_id}
/
shared-links
Create a shared link
curl --request POST \
  --url https://www.useroulette.com/api/v1/accounts/{account_id}/shared-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Series A Portfolio for ABC Capital",
  "description": "Selection of our top Series A companies for review",
  "password": "secure123",
  "expires_at": "2024-06-01T00:00:00Z",
  "companies": [
    {
      "company_id": "company-uuid-1",
      "permissions": "view_deck"
    },
    {
      "company_id": "company-uuid-2",
      "permissions": "view"
    },
    {
      "company_id": "company-uuid-3",
      "permissions": "full"
    }
  ]
}
'
{
  "success": true,
  "data": {
    "link": {
      "id": "new-link-uuid",
      "short_code": "xyz789ab",
      "short_url": "https://www.useroulette.com/s/xyz789ab"
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Generate keys from your account settings.

Include in header: Authorization: Bearer YOUR_API_KEY

Path Parameters

account_id
string<uuid>
required

The unique identifier of the account/team

Body

application/json
name
string
required

Internal name for the shared link

companies
object[]
required
Minimum array length: 1
description
string
password
string

Optional password protection

expires_at
string<date-time>

Optional expiration date

Response

Shared link created

success
boolean
data
object