API reference
Requests and responses are JSON, fields are snake_case and IDs are UUIDs. Most endpoints need a session; posting with a conversation token needs nothing else.
Base URL
https://api.fryll.comInbound
Conversation tokens
Messages
- PUTSave a message/conversations/{conversation_id}/messages/{message_id}/saved
- DELETEUnsave a message/conversations/{conversation_id}/messages/{message_id}/saved
- PUTAdd a reaction/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
- DELETERemove a reaction/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
- GETList messages/conversations/{conversation_id}/messages
- POSTCreate a message/conversations/{conversation_id}/messages
- GETGet a message/conversations/{conversation_id}/messages/{message_id}
- PATCHUpdate a message/conversations/{conversation_id}/messages/{message_id}
- DELETEDelete a message/conversations/{conversation_id}/messages/{message_id}
- GETList channel messages/channels/{channel_id}/messages
- POSTCreate a channel message/channels/{channel_id}/messages
- GETGet a channel message/channels/{channel_id}/messages/{message_id}
- PATCHUpdate a channel message/channels/{channel_id}/messages/{message_id}
- DELETEDelete a channel message/channels/{channel_id}/messages/{message_id}
Channels
Channel members
Direct conversations
Conversations
- GETGet the conversation read state/conversations/{conversation_id}/read-state
- PUTUpdate the conversation read state/conversations/{conversation_id}/read-state
- GETGet the channel read state/channels/{channel_id}/read-state
- PUTUpdate the channel read state/channels/{channel_id}/read-state
- GETGet the thread read state/threads/{thread_root_id}/read-state
- PUTUpdate the thread read state/threads/{thread_root_id}/read-state
- PUTUpdate the thread subscription/threads/{thread_root_id}/subscription
- GETList threads/threads
Saved messages
Search
Assets
Workspaces
- GETList your workspaces/workspaces
- POSTCreate a workspace/workspaces
- GETGet the workspace/workspace
- PATCHUpdate the workspace/workspace
- DELETEDelete the workspace/workspace
- PUTTransfer ownership of the workspace/workspace/owner
- PUTUpload a workspace avatar/workspace/avatar
- DELETERemove a workspace avatar/workspace/avatar
- GETDownload a workspace avatar/workspace/avatar/{avatar_id}
Workspace users
Workspace invitations
Workspace actors
- GETList workspace actors/workspace/actors
- GETGet your profile/workspace/actors/me
- PATCHUpdate your profile/workspace/actors/me
- GETGet a workspace actor/workspace/actors/{workspace_actor_id}
- PATCHUpdate a workspace actor/workspace/actors/{workspace_actor_id}
- PUTUpload an actor avatar/workspace/actors/{workspace_actor_id}/avatar
- DELETERemove an actor avatar/workspace/actors/{workspace_actor_id}/avatar
- GETDownload an actor avatar/workspace/actors/{workspace_actor_id}/avatar/{avatar_id}
Users
Auth
- POSTCreate an account/auth/register
- POSTSend a sign-in link/auth/magic-link
- POSTRecover an account/auth/recover
- POSTReset a password/auth/reset-password
- POSTSend a sign-in code/auth/email-code
- POSTSign in with a code/auth/verify-code
- POSTVerify an email address/auth/verify-email
- POSTSign in/auth/login
- POSTSign out/auth/logout
Realtime
Health
Activity
Push
Unread
Objects
What the API sends back, field by field, with an example of each.