Skip to main content

​
Share

Represents a share of an alert with another user, enabling collaboration.
​
id
string
required
Unique identifier for the share
​
alert_id
string
required
ID of the alert being shared
​
user_id
string
ID of the user the alert is shared with (for existing users)
​
email
string
Email address of the person the alert is shared with (for invitations)
​
permission
string
default:"read"
Permission level: read, write, or admin
​
created_at
string
ISO 8601 timestamp when the share was created
​
updated_at
string
ISO 8601 timestamp when the share was last updated

​
SharePermission Enum

Available permission levels:
  • read - Can view the alert and its mentions
  • write - Can view and curate mentions (mark as read, add tags, etc.)
  • admin - Full access including alert settings and sharing management

​
Example

{
  "id": "share_1234567890",
  "alert_id": "alert_1234567890",
  "user_id": "user_987654321",
  "email": "[email protected]",
  "permission": "write",
  "created_at": "2026-02-15T10:00:00Z",
  "updated_at": "2026-03-01T14:30:00Z"
}

​
Request Models

​
CreateShareRequest

Used when sharing an alert with another user.
​
email
string
required
Email address of the person to share with
​
permission
string
default:"read"
Permission level: read, write, or admin

​
UpdateShareRequest

Used when updating share permissions.
​
permission
string
Updated permission level

​
SharesResponse

Response containing a list of shares for an alert.
​
shares
array
required
List of Share objects

​
Example

{
  "shares": [
    {
      "id": "share_1",
      "alert_id": "alert_1234567890",
      "user_id": "user_1",
      "email": "[email protected]",
      "permission": "write",
      "created_at": "2026-01-15T10:00:00Z",
      "updated_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "share_2",
      "alert_id": "alert_1234567890",
      "user_id": "user_2",
      "email": "[email protected]",
      "permission": "admin",
      "created_at": "2026-02-01T14:30:00Z",
      "updated_at": "2026-02-01T14:30:00Z"
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us