Announcements
/
Bulk destroy announcements

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

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

Admins

Operations

Agreements

Operations

Announcements

Operations

List announcements

Request

Query
pageinteger

Page number

per_pageinteger

Items per page

search_querystring

Search query

sorted_bystring

Sort order

statusstring

Filter by status

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements?page=0&per_page=0&search_query=string&sorted_by=string&status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

announcements retrieved

Bodyapplication/json
announcementsArray of objects
metaobject
Response
application/json
{
  "announcements": [
    { … }
  ],
  "meta": {
    "request_id": "fcca8c13-a8de-4632-a3ef-4374f0dee632",
    "timestamp": "2025-05-19T20:01:35Z",
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Create announcement

Request

Bodyapplication/json
titlestringrequired
Example: "New Announcement"
descriptionstring
Example: "Announcement description"
activeboolean
Example: true
application_theme_template_idinteger
Example: 1
available_countriesArray of strings
Example: ["US","CA"]
display_commentsboolean
Example: false
image_urlstring
Example: "https://example.com/image.jpg"
video_urlstring
Example: "https://example.com/video.mp4"
pdf_urlstring
Example: "https://example.com/document.pdf"
powerpoint_urlstring
Example: "https://example.com/presentation.ppt"
no_indexboolean
Example: false
media_typestring
Example: "update"
rank_idsArray of integers
Example: [1,2]
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "New Announcement",
    "description": "Announcement description",
    "active": true,
    "application_theme_template_id": 1,
    "available_countries": [
      "US",
      "CA"
    ],
    "display_comments": false,
    "image_url": "https://example.com/image.jpg",
    "video_url": "https://example.com/video.mp4",
    "pdf_url": "https://example.com/document.pdf",
    "powerpoint_url": "https://example.com/presentation.ppt",
    "no_index": false,
    "media_type": "update",
    "rank_ids": [
      1,
      2
    ]
  }'

Responses

announcement created

Bodyapplication/json
announcementobject
Response
application/json
{
  "announcement": {
    "id": 48,
    "active": true,
    "application_theme_template_id": 8,
    "country_ids": [ … ],
    "description": "A sample description",
    "display_comments": false,
    "image_url": "https://example.com/sample-image.jpg",
    "kind": "image",
    "media_type": "update",
    "no_index": false,
    "pdf_url": "https://example.com/sample-pdf.pdf",
    "powerpoint_url": "https://example.com/sample-powerpoint.ppt",
    "rank_ids": [ … ],
    "title": "Example Title",
    "video_url": "https://example.com/sample-video.mp4"
  }
}

Bulk destroy announcements

Request

Bodyapplication/json
idsArray of integersrequired
Example: [1,2,3]
curl -i -X DELETE \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      1,
      2,
      3
    ]
  }'

Responses

announcements deleted

Bodyapplication/json
messagestring
Example: "Success"
Response
application/json
{
  "message": "Success"
}

Get announcement

Request

Path
idintegerrequired

Announcement ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

announcement found

Bodyapplication/json
announcementobject
Response
application/json
{
  "announcement": {
    "id": 48,
    "active": true,
    "application_theme_template_id": 8,
    "country_ids": [ … ],
    "description": "A sample description",
    "display_comments": false,
    "image_url": "https://example.com/sample-image.jpg",
    "kind": "image",
    "media_type": "update",
    "no_index": false,
    "pdf_url": "https://example.com/sample-pdf.pdf",
    "powerpoint_url": "https://example.com/sample-powerpoint.ppt",
    "rank_ids": [ … ],
    "title": "Example Title",
    "video_url": "https://example.com/sample-video.mp4"
  }
}

Update announcement

Request

Path
idintegerrequired

Announcement ID

Bodyapplication/json
titlestring
Example: "Updated Announcement"
descriptionstring
Example: "Updated description"
activeboolean
Example: true
application_theme_template_idinteger
Example: 1
available_countriesArray of strings
Example: ["US","CA"]
display_commentsboolean
Example: false
image_urlstring
Example: "https://example.com/image.jpg"
video_urlstring
Example: "https://example.com/video.mp4"
pdf_urlstring
Example: "https://example.com/document.pdf"
powerpoint_urlstring
Example: "https://example.com/presentation.ppt"
no_indexboolean
Example: false
media_typestring
Example: "update"
rank_idsArray of integers
Example: [1,2]
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Updated Announcement",
    "description": "Updated description",
    "active": true,
    "application_theme_template_id": 1,
    "available_countries": [
      "US",
      "CA"
    ],
    "display_comments": false,
    "image_url": "https://example.com/image.jpg",
    "video_url": "https://example.com/video.mp4",
    "pdf_url": "https://example.com/document.pdf",
    "powerpoint_url": "https://example.com/presentation.ppt",
    "no_index": false,
    "media_type": "update",
    "rank_ids": [
      1,
      2
    ]
  }'

Responses

announcement updated

Bodyapplication/json
announcementobject
Response
application/json
{
  "announcement": {
    "id": 48,
    "active": true,
    "application_theme_template_id": 8,
    "country_ids": [ … ],
    "description": "A sample description",
    "display_comments": false,
    "image_url": "https://example.com/sample-image.jpg",
    "kind": "image",
    "media_type": "update",
    "no_index": false,
    "pdf_url": "https://example.com/sample-pdf.pdf",
    "powerpoint_url": "https://example.com/sample-powerpoint.ppt",
    "rank_ids": [ … ],
    "title": "Example Title",
    "video_url": "https://example.com/sample-video.mp4"
  }
}

Delete announcement

Request

Path
idintegerrequired

Announcement ID

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/announcements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

announcement deleted

Bodyapplication/json
announcementobject
Response
application/json
{
  "announcement": {
    "id": 48,
    "active": true,
    "application_theme_template_id": 8,
    "country_ids": [ … ],
    "description": "A sample description",
    "display_comments": false,
    "image_url": "https://example.com/sample-image.jpg",
    "kind": "image",
    "media_type": "update",
    "no_index": false,
    "pdf_url": "https://example.com/sample-pdf.pdf",
    "powerpoint_url": "https://example.com/sample-powerpoint.ppt",
    "rank_ids": [ … ],
    "title": "Example Title",
    "video_url": "https://example.com/sample-video.mp4"
  }
}

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations