Company Media
/
Get company media

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

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

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 Media

Operations

Delete company media

Request

Delete a media item (soft delete)

Path
idintegerrequired

Media ID

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

Responses

Media deleted successfully

Bodyapplication/json
string
Response
application/json
"string"

Get company media

Request

Get a specific media item by ID

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

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

Responses

Media retrieved successfully

Bodyapplication/json
idinteger
user_idinteger or null
titlestring
descriptionobject or null
media_typestring
media_formatstring or null
strippedstring or null
share_linkstring or null
preview_linkstring or null
video_urlstring or null
image_urlstring or null
pdf_urlstring or null
activeboolean
viewsinteger
leadsinteger
watchobject or null
video_statusstring or null
durationinteger or null
kindstring or null
cta_urlstring or null
cta_button_textstring or null
cta_action_typestring or null
cta_enabledboolean
labelstring or null
display_tagstring or null
promptsArray of objects
attached_shareablesArray of objects
ranksArray of objects
visibilityinteger or null
video_shopping_enabledboolean
prompts_enabledboolean
created_atstring
application_theme_template_idinteger or null
settingsobject
countriesArray of objects
Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "media_type": "string",
  "media_format": "string",
  "stripped": "string",
  "share_link": "string",
  "preview_link": "string",
  "video_url": "string",
  "image_url": "string",
  "pdf_url": "string",
  "active": true,
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "kind": "string",
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_action_type": "string",
  "cta_enabled": true,
  "label": "string",
  "display_tag": "string",
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "ranks": [
    {}
  ],
  "visibility": 0,
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "created_at": "string",
  "application_theme_template_id": 0,
  "settings": {},
  "countries": [
    { … }
  ]
}

Update company media

Request

Update an existing media item

Path
idintegerrequired

Media ID

Example: 1
Bodyapplication/jsonrequired
mediumobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/media/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "medium": {
      "user_id": 0,
      "media_type": "share",
      "image_url": "string",
      "video_url": "string",
      "pdf_url": "string",
      "powerpoint_url": "string",
      "title": "string",
      "description": "string",
      "active": true,
      "compressed_image_url": "string",
      "prompts_enabled": true,
      "kind": "string",
      "visibility": "string",
      "cta_enabled": true,
      "cta_action_type": "string",
      "cta_url": "string",
      "cta_button_text": "string",
      "no_index": true,
      "display_comments": true,
      "category": "string",
      "display_shop": true,
      "dam_asset_id": 0,
      "dam_asset_code": "string",
      "lead_capture": true,
      "video_shopping_enabled": true,
      "application_theme_template_id": 0,
      "settings": {},
      "label": {
        "id": 0,
        "title": "string"
      },
      "subtitles": [
        {
          "lang": "string",
          "src": "string"
        }
      ],
      "available_countries": [
        "string"
      ],
      "tags_attributes": [
        {
          "id": 0,
          "_destroy": true,
          "name": "string"
        }
      ],
      "prompts_attributes": [
        {
          "id": 0,
          "title": "string",
          "content": "string",
          "_destroy": true
        }
      ],
      "attached_shareables_attributes": [
        {
          "id": 0,
          "attachment_type": "string",
          "attachment_id": 0,
          "timestamp": "string",
          "_destroy": true
        }
      ]
    }
  }'

Responses

Media updated successfully

Bodyapplication/json
mediumobject
metaobject
Response
application/json
{
  "medium": {
    "id": 0,
    "user_id": 0,
    "title": "string",
    "description": {},
    "media_type": "string",
    "media_format": "string",
    "stripped": "string",
    "share_link": "string",
    "preview_link": "string",
    "video_url": "string",
    "image_url": "string",
    "pdf_url": "string",
    "active": true,
    "views": 0,
    "leads": 0,
    "watch": {},
    "video_status": "string",
    "duration": 0,
    "kind": "string",
    "cta_url": "string",
    "cta_button_text": "string",
    "cta_action_type": "string",
    "cta_enabled": true,
    "label": "string",
    "display_tag": "string",
    "prompts": [ … ],
    "attached_shareables": [ … ],
    "ranks": [ … ],
    "visibility": 0,
    "video_shopping_enabled": true,
    "prompts_enabled": true,
    "created_at": "string",
    "application_theme_template_id": 0,
    "settings": {},
    "countries": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

List company media

Request

Get all company media with pagination and filtering. Only returns 'share' type media by default.

Query
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
search_querystring

Search by title

sorted_bystring

Sort order (title_desc, created_at_desc, etc)

Default "title_desc"
statusstring

Filter by status (active/inactive)

language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

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

Responses

Company media retrieved successfully

Bodyapplication/jsonArray [
One of:
paginationobject
]
Response
application/json
[
  {
    "pagination": { … }
  }
]

Create company media

Request

Create a new media item for the company

Bodyapplication/jsonrequired
mediumobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/media \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "medium": {
      "user_id": 0,
      "language": "string",
      "media_type": "share",
      "image_url": "string",
      "video_url": "string",
      "pdf_url": "string",
      "powerpoint_url": "string",
      "title": "string",
      "description": "string",
      "active": true,
      "compressed_image_url": "string",
      "prompts_enabled": true,
      "kind": "string",
      "visibility": "string",
      "cta_enabled": true,
      "cta_action_type": "string",
      "cta_url": "string",
      "cta_button_text": "string",
      "no_index": true,
      "display_comments": true,
      "category": "string",
      "display_shop": true,
      "dam_asset_id": 0,
      "dam_asset_code": "string",
      "lead_capture": true,
      "video_shopping_enabled": true,
      "application_theme_template_id": 0,
      "settings": {},
      "label": {
        "id": 0,
        "title": "string"
      },
      "subtitles": [
        {
          "lang": "string",
          "src": "string"
        }
      ],
      "available_countries": [
        "string"
      ],
      "tags_attributes": [
        {
          "_destroy": true,
          "name": "string"
        }
      ],
      "prompts_attributes": [
        {
          "id": 0,
          "title": "string",
          "content": "string",
          "_destroy": true
        }
      ],
      "attached_shareables_attributes": [
        {
          "id": 0,
          "attachment_type": "string",
          "attachment_id": 0,
          "timestamp": "string",
          "_destroy": true
        }
      ]
    }
  }'

Responses

Media created successfully

Bodyapplication/json
mediumobject
metaobject
Response
application/json
{
  "medium": {},
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Send media to top

Request

Move a media item to the top of the list by updating its created_at timestamp

Path
idintegerrequired

Media ID

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

Responses

Media sent to top successfully

Bodyapplication/json
idinteger
user_idinteger or null
titlestring
descriptionobject or null
media_typestring
media_formatstring or null
strippedstring or null
share_linkstring or null
preview_linkstring or null
video_urlstring or null
image_urlstring or null
pdf_urlstring or null
activeboolean
viewsinteger
leadsinteger
watchobject or null
video_statusstring or null
durationinteger or null
kindstring or null
cta_urlstring or null
cta_button_textstring or null
cta_action_typestring or null
cta_enabledboolean
labelstring or null
display_tagstring or null
promptsArray of objects
attached_shareablesArray of objects
ranksArray of objects
visibilityinteger or null
video_shopping_enabledboolean
prompts_enabledboolean
created_atstring
application_theme_template_idinteger or null
settingsobject
countriesArray of objects
Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "media_type": "string",
  "media_format": "string",
  "stripped": "string",
  "share_link": "string",
  "preview_link": "string",
  "video_url": "string",
  "image_url": "string",
  "pdf_url": "string",
  "active": true,
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "kind": "string",
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_action_type": "string",
  "cta_enabled": true,
  "label": "string",
  "display_tag": "string",
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "ranks": [
    {}
  ],
  "visibility": 0,
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "created_at": "string",
  "application_theme_template_id": 0,
  "settings": {},
  "countries": [
    { … }
  ]
}

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

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

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

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json
idinteger
user_idinteger or null
titlestring
descriptionobject or null
media_typestring
media_formatstring or null
strippedstring or null
share_linkstring or null
preview_linkstring or null
video_urlstring or null
image_urlstring or null
pdf_urlstring or null
activeboolean
viewsinteger
leadsinteger
watchobject or null
video_statusstring or null
durationinteger or null
kindstring or null
cta_urlstring or null
cta_button_textstring or null
cta_action_typestring or null
cta_enabledboolean
labelstring or null
display_tagstring or null
promptsArray of objects
attached_shareablesArray of objects
ranksArray of objects
visibilityinteger or null
video_shopping_enabledboolean
prompts_enabledboolean
created_atstring
application_theme_template_idinteger or null
settingsobject
countriesArray of objects
Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "media_type": "string",
  "media_format": "string",
  "stripped": "string",
  "share_link": "string",
  "preview_link": "string",
  "video_url": "string",
  "image_url": "string",
  "pdf_url": "string",
  "active": true,
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "kind": "string",
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_action_type": "string",
  "cta_enabled": true,
  "label": "string",
  "display_tag": "string",
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "ranks": [
    {}
  ],
  "visibility": 0,
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "created_at": "string",
  "application_theme_template_id": 0,
  "settings": {},
  "countries": [
    { … }
  ]
}