Skip to main content
POST
http://localhost:3000
/
resource-scope-links
curl -X POST 'https://api.example.com/resource-scope-links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceId": "resource_doc_123",
    "scopeId": "scope_sales",
    "linkType": "share",
    "metadata": {
      "sharedBy": "user_jane",
      "accessLevel": "read-only"
    }
  }'

{
  "id": "rsl_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "resourceId": "resource_doc_123",
  "scopeId": "scope_sales",
  "linkType": "share",
  "metadata": {
    "sharedBy": "user_jane",
    "accessLevel": "read-only"
  },
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Request Body

​
id
string
Optional client-provided ID. Format: rsl_{uuidv7}
​
resourceId
string
required
ID of the resource to link
​
scopeId
string
required
ID of the scope to link to
​
linkType
string
required
Type of link: share, alias, or mirror
​
metadata
object
Optional metadata for this link

​
Response

Returns the created resource scope link object. 
curl -X POST 'https://api.example.com/resource-scope-links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceId": "resource_doc_123",
    "scopeId": "scope_sales",
    "linkType": "share",
    "metadata": {
      "sharedBy": "user_jane",
      "accessLevel": "read-only"
    }
  }'

{
  "id": "rsl_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "resourceId": "resource_doc_123",
  "scopeId": "scope_sales",
  "linkType": "share",
  "metadata": {
    "sharedBy": "user_jane",
    "accessLevel": "read-only"
  },
  "createdAt": "2024-01-15T10:30:00Z"
}