Conversations

Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation.

Download OpenAPI description
company.api.json
company.api.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/company.api/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Conversations

Operations

List User Conversations

Request

Get all conversations for the user, with optional filtering by status, kind, and pinned state. Supports pagination and various conversation templates.

Query
statusstring

Filter conversations by status

Enum"open""closed"
kindstring

Filter conversations by kind

Enum"direct""group"
pinnedboolean

Filter conversations by pinned state

pageinteger

Page number for pagination

Default 1
templatestring

Conversation template to filter by

Enum"new_messages""pinned""team_groups""team_directs""teams""teams_unread""teams_read""channels""sms""sms_read"
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/messaging/conversations?kind=direct&page=1&pinned=true&status=open&template=new_messages'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
team_directsArray of objects(TeamDirect)required
Example: [{"pagination":{"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}},{"items":[{"id":3,"name":"Britta Padberg","description":null,"kind":"direct","type":"DirectConversation","status":"open","created_at":"2024-08-19T04:52:05.030Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":null,"total_recipients":2,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":false,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":34,"first_name":"Britta","last_name":"Padberg","avatar_url":null,"image_url":null,"receivable_id":34,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.873Z","country_name":null},{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"}],"creator":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]}]
team_directs[].​paginationobject(Pagination)
Example: {"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}
team_directs[].​itemsArray of objects(Item13)
Example: [{"id":3,"name":"Britta Padberg","description":null,"kind":"direct","type":"DirectConversation","status":"open","created_at":"2024-08-19T04:52:05.030Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":null,"total_recipients":2,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":false,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":34,"first_name":"Britta","last_name":"Padberg","avatar_url":null,"image_url":null,"receivable_id":34,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.873Z","country_name":null},{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"}],"creator":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]
team_groupsArray of objects(TeamGroup)required
Example: [{"pagination":{"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}},{"items":[{"id":5,"name":"Britta & 1 other","description":null,"kind":"group","type":"GroupConversation","status":"open","created_at":"2024-08-19T04:53:19.442Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":null,"total_recipients":3,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":false,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":34,"first_name":"Britta","last_name":"Padberg","avatar_url":null,"image_url":null,"receivable_id":34,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.873Z","country_name":null},{"id":56,"first_name":"Ed","last_name":"Rau","avatar_url":null,"image_url":null,"receivable_id":56,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.903Z","country_name":null},{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"}],"creator":{"id":34,"first_name":"Britta","last_name":"Padberg","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]}]
team_groups[].​paginationobject(Pagination)
Example: {"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}
team_groups[].​itemsArray of objects(Item13)
Example: [{"id":3,"name":"Britta Padberg","description":null,"kind":"direct","type":"DirectConversation","status":"open","created_at":"2024-08-19T04:52:05.030Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":null,"total_recipients":2,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":false,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":34,"first_name":"Britta","last_name":"Padberg","avatar_url":null,"image_url":null,"receivable_id":34,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.873Z","country_name":null},{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"}],"creator":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]
channelsArray of objects(Channel)required
Example: [{"pagination":{"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}},{"items":[{"id":6,"name":"all people","description":null,"kind":"channel","type":"ChannelConversation","status":"open","created_at":"2024-08-19T04:59:27.361Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":false,"total_recipients":61,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":true,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"},{"id":3,"first_name":"Berry","last_name":"Schaefer","avatar_url":null,"image_url":null,"receivable_id":3,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":4,"first_name":"Debbra","last_name":"Parker","avatar_url":null,"image_url":null,"receivable_id":4,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":5,"first_name":"Marcelino","last_name":"Olson","avatar_url":null,"image_url":null,"receivable_id":5,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":6,"first_name":"Doug","last_name":"Feeney","avatar_url":null,"image_url":null,"receivable_id":6,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":7,"first_name":"Karlene","last_name":"Treutel","avatar_url":null,"image_url":null,"receivable_id":7,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null}],"creator":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]}]
channels[].​paginationobject(Pagination)
Example: {"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}
channels[].​itemsArray of objects(Item15)
Example: [{"id":6,"name":"all people","description":null,"kind":"channel","type":"ChannelConversation","status":"open","created_at":"2024-08-19T04:59:27.361Z","pinned":false,"unread_messages_count":0,"sms_enabled?":false,"draft_message":null,"email_enabled?":false,"conversation_type":"internal","messaging_enabled?":true,"broadcasting":false,"total_recipients":61,"unread":false,"image_url":null,"auto_add_recipients":true,"muted":true,"announcing":false,"scheduled_messages_count":0,"avatar_background_color":null,"avatar_emoji":null,"avatar_url":null,"recipients":[{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"},{"id":3,"first_name":"Berry","last_name":"Schaefer","avatar_url":null,"image_url":null,"receivable_id":3,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":4,"first_name":"Debbra","last_name":"Parker","avatar_url":null,"image_url":null,"receivable_id":4,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":5,"first_name":"Marcelino","last_name":"Olson","avatar_url":null,"image_url":null,"receivable_id":5,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":6,"first_name":"Doug","last_name":"Feeney","avatar_url":null,"image_url":null,"receivable_id":6,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":7,"first_name":"Karlene","last_name":"Treutel","avatar_url":null,"image_url":null,"receivable_id":7,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null}],"creator":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]
customersArray of objects(Customer2)required
Example: [{"pagination":{"current":1,"previous":null,"next":null,"per_page":5,"pages":0,"count":0}},{"items":[]}]
customers[].​paginationobject(Pagination)
Example: {"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}
customers[].​itemsArray of strings
Response
application/json; charset=utf-8
{
  "team_directs": [
    { … },
    { … }
  ],
  "team_groups": [
    { … },
    { … }
  ],
  "channels": [
    { … },
    { … }
  ],
  "customers": [
    { … },
    { … }
  ]
}

Create Messaging Conversation

Request

Create a new conversation for a user with specified recipients. The conversation can be of different types including direct, group, channel, email or SMS conversations.

Bodyapplication/jsonrequired
conversationobject(Conversation)required
Example: {"type":"DirectConversation"}
conversation.​typestringrequired
Example: "DirectConversation"
recipientsArray of objects(Recipient3)required
Example: [{"uid":12}]
recipients[].​uidinteger(int32)required
Example: 12
userobject(User11)required
Example: {"email":"admin@fluid.app"}
user.​emailstringrequired
Example: "admin@fluid.app"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/messaging/conversations.json \
  -H 'Content-Type: application/json' \
  -d '{
    "conversation": {
      "type": "DirectConversation"
    },
    "recipients": [
      {
        "uid": 12
      }
    ],
    "user": {
      "email": "admin@fluid.app"
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 8
namestringrequired
Example: "Ada Stracke"
descriptionstringrequired
kindstringrequired
Example: "direct"
typestringrequired
Example: "DirectConversation"
statusstringrequired
Example: "initiated"
created_atstringrequired
Example: "2024-08-19T16:58:59.023Z"
pinnedbooleanrequired
unread_messages_countinteger(int32)required
sms_enabled?booleanrequired
draft_messagestringrequired
email_enabled?booleanrequired
conversation_typestringrequired
Example: "internal"
messaging_enabled?booleanrequired
Example: true
broadcastingstringrequired
total_recipientsinteger(int32)required
Example: 2
unreadbooleanrequired
image_urlstringrequired
auto_add_recipientsbooleanrequired
Example: true
mutedbooleanrequired
announcingbooleanrequired
scheduled_messages_countinteger(int32)required
avatar_background_colorstringrequired
avatar_emojistringrequired
avatar_urlstringrequired
recipientsArray of objects(Recipient2)required
Example: [{"id":12,"first_name":"Ada","last_name":"Stracke","avatar_url":null,"image_url":null,"receivable_id":12,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"offline","last_online":null,"country_name":null},{"id":1,"first_name":"John","last_name":"Admin","avatar_url":null,"image_url":null,"receivable_id":1,"receivable_type":"UserCompany","discarded_at":null,"left_conversation_at":null,"blocked":false,"status":"online","last_online":"2024-08-19T15:02:44.914Z","country_name":"United States"}]
recipients[].​idinteger(int32)required
Example: 1
recipients[].​first_namestringrequired
Example: "John"
recipients[].​last_namestringrequired
Example: "Admin"
recipients[].​avatar_urlstringrequired
recipients[].​image_urlstringrequired
recipients[].​receivable_idinteger(int32)required
Example: 1
recipients[].​receivable_typestringrequired
Example: "UserCompany"
recipients[].​discarded_atstringrequired
recipients[].​left_conversation_atstringrequired
recipients[].​blockedbooleanrequired
recipients[].​statusstringrequired
Example: "online"
recipients[].​last_onlinestringrequired
Example: "2024-08-19T15:02:44.914Z"
recipients[].​country_namestringrequired
Example: "United States"
creatorobject(Creator)required
Example: {"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}
creator.​idinteger(int32)required
Example: 1
creator.​first_namestringrequired
Example: "John"
creator.​last_namestringrequired
Example: "Admin"
creator.​image_urlstringrequired
creator.​discarded_atstringrequired
creator.​blockedbooleanrequired
creator.​blockerbooleanrequired
Response
application/json; charset=utf-8
{
  "id": 8,
  "name": "Ada Stracke",
  "description": null,
  "kind": "direct",
  "type": "DirectConversation",
  "status": "initiated",
  "created_at": "2024-08-19T16:58:59.023Z",
  "pinned": false,
  "unread_messages_count": 0,
  "sms_enabled?": false,
  "draft_message": null,
  "email_enabled?": false,
  "conversation_type": "internal",
  "messaging_enabled?": true,
  "broadcasting": null,
  "total_recipients": 2,
  "unread": false,
  "image_url": null,
  "auto_add_recipients": true,
  "muted": false,
  "announcing": false,
  "scheduled_messages_count": 0,
  "avatar_background_color": null,
  "avatar_emoji": null,
  "avatar_url": null,
  "recipients": [
    { … },
    { … }
  ],
  "creator": {
    "id": 1,
    "first_name": "John",
    "last_name": "Admin",
    "image_url": null,
    "discarded_at": null,
    "blocked": false,
    "blocker": false
  }
}

Get Conversation Details

Request

Retrieves detailed information about a specific conversation

Path
idintegerrequired

Unique identifier of the conversation to retrieve

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/messaging/conversations/{id}.json'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

Countries

Operations

Currencies

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default MySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Events

Operations

FairShare Order Journey

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations