Messages

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

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

Create Conversation Message

Request

Create a message on a conversation.

Path
conversationIdstringrequired

ID of the conversation to create message in

Bodyapplication/jsonrequired
messageobject(Message)required
Example: {"body":"How is it going?","theme":"inquiry","type":"DirectMessage","sent_at":"2022-02-21T11:46:42.379Z","attachments_attributes":[{"filename":"test.jpg","url":"https://picsum.photos/id/237/200/300","kind":"image"}]}
message.​bodystringrequired
Example: "How is it going?"
message.​themestringrequired
Example: "inquiry"
message.​typestringrequired
Example: "DirectMessage"
message.​sent_atstringrequired
Example: "2022-02-21T11:46:42.379Z"
message.​attachments_attributesArray of objects(AttachmentsAttribute)required
Example: [{"filename":"test.jpg","url":"https://picsum.photos/id/237/200/300","kind":"image"}]
message.​attachments_attributes[].​filenamestringrequired
Example: "test.jpg"
message.​attachments_attributes[].​urlstringrequired
Example: "https://picsum.photos/id/237/200/300"
message.​attachments_attributes[].​kindstringrequired
Example: "image"
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/{conversationId}/messages.json' \
  -H 'Content-Type: application/json' \
  -d '{
    "message": {
      "body": "How is it going?",
      "theme": "inquiry",
      "type": "DirectMessage",
      "sent_at": "2022-02-21T11:46:42.379Z",
      "attachments_attributes": [
        {
          "filename": "test.jpg",
          "url": "https://picsum.photos/id/237/200/300",
          "kind": "image"
        }
      ]
    },
    "user": {
      "email": "admin@fluid.app"
    }
  }'

Responses

Created

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: 34
bodystringrequired
Example: "How is it going?"
typestringrequired
Example: "DirectMessage"
created_atstringrequired
Example: "2024-08-19T17:04:58.312Z"
updated_atstringrequired
Example: "2024-08-19T17:04:58.702Z"
deleted_atstringrequired
edited_atstringrequired
conversation_idinteger(int32)required
Example: 8
seen_byArray of objects(SeenBy)required
Example: [{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"seen_at":"2024-08-19T17:04:58.562Z"}]
seen_by[].​idinteger(int32)required
Example: 1
seen_by[].​first_namestringrequired
Example: "John"
seen_by[].​last_namestringrequired
Example: "Admin"
seen_by[].​image_urlstringrequired
seen_by[].​seen_atstringrequired
Example: "2024-08-19T17:04:58.562Z"
attachmentsArray of objects(Attachment2)required
Example: [{"id":2,"url":"https://picsum.photos/id/237/200/300","filename":"test.jpg","kind":"image","image_url":"https://picsum.photos/id/237/200/300","image_path":null,"content_type":null,"attachable_type":"Message","attachable_id":34,"thumbnail_url":"https://picsum.photos/id/237/200/300","metadata":null,"content_size":null}]
attachments[].​idinteger(int32)required
Example: 2
attachments[].​urlstringrequired
Example: "https://picsum.photos/id/237/200/300"
attachments[].​filenamestringrequired
Example: "test.jpg"
attachments[].​kindstringrequired
Example: "image"
attachments[].​image_urlstringrequired
Example: "https://picsum.photos/id/237/200/300"
attachments[].​image_pathstringrequired
attachments[].​content_typestringrequired
attachments[].​attachable_typestringrequired
Example: "Message"
attachments[].​attachable_idinteger(int32)required
Example: 34
attachments[].​thumbnail_urlstringrequired
Example: "https://picsum.photos/id/237/200/300"
attachments[].​metadatastringrequired
attachments[].​content_sizestringrequired
reaction_statsstringrequired
reactionstringrequired
metadatastringrequired
seen_by_countinteger(int32)required
Example: 1
emoji_only_countinteger(int32)required
mentioned_recipientsArray of stringsrequired
Example: []
sent_atstringrequired
Example: "2024-08-19T17:04:58.701Z"
replied_to_messagestringrequired
sender_recipientobject(SenderRecipient)required
Example: {"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}
sender_recipient.​idinteger(int32)required
Example: 1
sender_recipient.​first_namestringrequired
Example: "John"
sender_recipient.​last_namestringrequired
Example: "Admin"
sender_recipient.​image_urlstringrequired
sender_recipient.​discarded_atstringrequired
sender_recipient.​blockedbooleanrequired
sender_recipient.​blockerbooleanrequired
Response
application/json; charset=utf-8
{
  "id": 34,
  "body": "How is it going?",
  "type": "DirectMessage",
  "created_at": "2024-08-19T17:04:58.312Z",
  "updated_at": "2024-08-19T17:04:58.702Z",
  "deleted_at": null,
  "edited_at": null,
  "conversation_id": 8,
  "seen_by": [
    { … }
  ],
  "attachments": [
    { … }
  ],
  "reaction_stats": null,
  "reaction": null,
  "metadata": null,
  "seen_by_count": 1,
  "emoji_only_count": 0,
  "mentioned_recipients": [],
  "sent_at": "2024-08-19T17:04:58.701Z",
  "replied_to_message": null,
  "sender_recipient": {
    "id": 1,
    "first_name": "John",
    "last_name": "Admin",
    "image_url": null,
    "discarded_at": null,
    "blocked": false,
    "blocker": false
  }
}

Get Conversation Messages

Request

Retrieves all messages belonging to a specific conversation

Path
conversationIdintegerrequired

Unique identifier of the conversation

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

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-8Array [
paginationobject(Pagination)
Example: {"current":1,"previous":null,"next":null,"per_page":5,"pages":1,"count":1}
itemsArray of objects(Item16)
Example: [{"id":34,"body":"How is it going?","type":"DirectMessage","created_at":"2024-08-19T17:04:58.312Z","updated_at":"2024-08-19T17:04:58.702Z","deleted_at":null,"edited_at":null,"conversation_id":8,"seen_by":[{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"seen_at":"2024-08-19T17:04:58.562Z"}],"attachments":[{"id":2,"url":"https://picsum.photos/id/237/200/300","filename":"test.jpg","kind":"image","image_url":"https://picsum.photos/id/237/200/300","image_path":null,"content_type":null,"attachable_type":"Message","attachable_id":34,"thumbnail_url":"https://picsum.photos/id/237/200/300","metadata":null,"content_size":null}],"reaction_stats":null,"reaction":null,"metadata":{"links":[]},"seen_by_count":1,"emoji_only_count":0,"mentioned_recipients":[],"sent_at":"2024-08-19T17:04:58.701Z","replied_to_message":null,"sender_recipient":{"id":1,"first_name":"John","last_name":"Admin","image_url":null,"discarded_at":null,"blocked":false,"blocker":false}}]
]
Response
application/json; charset=utf-8
[
  {
    "pagination": { … }
  },
  {
    "items": [ … ]
  }
]

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