Create a post

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

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 Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

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

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

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

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi Factor Authentications

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

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

List posts

Request

List all posts for a company with pagination and filtering

Query

pageinteger

Page number for pagination

per_pageinteger

Number of items per page

activeboolean

Filter by active status

search_querystring

Search query for posts

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

Responses

successful

Bodyapplication/json

postsArray of objects

metaobject

Response

application/json

{
  "posts": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "total_count": 10,
    "total_pages": 2,
    "current_page": 1
  }
}

Create a post

Request

Create a new post post

Bodyapplication/json

postobjectrequired

post.titlestringrequired

Title of the post

Example: "My New Post"

post.descriptionstring

Content/description of the post

Example: "Post content here"

post.image_urlstring

URL to post cover image

Example: "https://example.com/image.jpg"

post.activeboolean

Whether the post is active

Example: true

post.application_theme_template_idinteger

ID of the theme template to use

Example: 1

post.country_idsArray of arrays

Array of country IDs

Example: [1,2]

post.use_search_engineboolean

Whether to optimize for search engines

Example: true

post.show_on_site_searchboolean

Whether to show in site search

Example: true

post.post_datestring(date)

Date of the post

Example: "2021-01-01"

post.post_authorstring

Author of the post

Example: "John Doe"

post.summarystring

Summary of the post

Example: "This is a summary of the post"

post.preview_urlstring

URL to preview the post

Example: "https://example.com/preview"

post.category_idinteger

ID of the category

Example: 1

post.collection_idsArray of arrays

Array of collection IDs

Example: [1,2]

post.search_engine_optimizer_attributesobject

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/posts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "My New Post",
      "description": "Post content here",
      "image_url": "https://example.com/image.jpg",
      "active": true,
      "application_theme_template_id": 1,
      "country_ids": [
        1,
        2
      ],
      "use_search_engine": true,
      "show_on_site_search": true,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post",
      "preview_url": "https://example.com/preview",
      "category_id": 1,
      "collection_ids": [
        1,
        2
      ],
      "search_engine_optimizer_attributes": {
        "title": "string",
        "description": "string",
        "image_url": "string"
      }
    }
  }'

Responses

created

Bodyapplication/json

postobject

metaobject

Response

application/json

{
  "post": {
    "id": 0,
    "title": "string",
    "description": "string",
    "slug": "string",
    "image_url": "string",
    "active": true,
    "application_theme_template_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "countries": [ … ],
    "custom_slug": true,
    "use_search_engine": true,
    "show_on_site_search": false,
    "post_date": "2021-01-01",
    "post_author": "John Doe",
    "summary": "This is a summary of the post",
    "preview_url": "https://example.com/preview",
    "category": { … },
    "collections": [ … ],
    "search_engine_optimizer": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show a post

Request

Get details of a specific post

Path

idintegerrequired

Post ID

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

Responses

successful

Bodyapplication/json

postobject

metaobject

Response

application/json

{
  "post": {
    "id": 0,
    "title": "string",
    "description": "string",
    "slug": "string",
    "image_url": "string",
    "active": true,
    "application_theme_template_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "countries": [ … ],
    "custom_slug": true,
    "use_search_engine": true,
    "show_on_site_search": false,
    "post_date": "2021-01-01",
    "post_author": "John Doe",
    "summary": "This is a summary of the post",
    "preview_url": "https://example.com/preview",
    "category": { … },
    "collections": [ … ],
    "search_engine_optimizer": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a post

Request

Update an existing post

Path

idintegerrequired

Post ID

Bodyapplication/json

postobjectrequired

post.titlestring

Title of the post

Example: "Updated Post Title"

post.descriptionstring

Content/description of the post

Example: "Updated content"

post.image_urlstring

URL to post cover image

Example: "https://example.com/new-image.jpg"

post.activeboolean

Whether the post is active

Example: false

post.application_theme_template_idinteger

ID of the theme template to use

Example: 2

post.post_datestring(date)

Example: "2021-01-01"

post.post_authorstring

Example: "John Doe"

post.summarystring

Example: "This is a summary of the post"

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/posts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "Updated Post Title",
      "description": "Updated content",
      "image_url": "https://example.com/new-image.jpg",
      "active": false,
      "application_theme_template_id": 2,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post"
    }
  }'

Responses

successful

Bodyapplication/json

postobject

metaobject

Response

application/json

{
  "post": {
    "id": 0,
    "title": "string",
    "description": "string",
    "slug": "string",
    "image_url": "string",
    "active": true,
    "application_theme_template_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "countries": [ … ],
    "custom_slug": true,
    "use_search_engine": true,
    "show_on_site_search": false,
    "post_date": "2021-01-01",
    "post_author": "John Doe",
    "summary": "This is a summary of the post",
    "preview_url": "https://example.com/preview",
    "category": { … },
    "collections": [ … ],
    "search_engine_optimizer": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a post

Request

Update an existing post (PUT method)

Path

idintegerrequired

Post ID

Bodyapplication/json

postobjectrequired

post.titlestring

Title of the post

Example: "Updated Post Title"

post.descriptionstring

Content/description of the post

Example: "Updated content"

post.image_urlstring

URL to post cover image

Example: "https://example.com/new-image.jpg"

post.activeboolean

Whether the post is active

Example: false

post.application_theme_template_idinteger

ID of the theme template to use

Example: 2

post.post_datestring(date)

Example: "2021-01-01"

post.post_authorstring

Example: "John Doe"

post.summarystring

Example: "This is a summary of the post"

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/posts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "Updated Post Title",
      "description": "Updated content",
      "image_url": "https://example.com/new-image.jpg",
      "active": false,
      "application_theme_template_id": 2,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post"
    }
  }'

Responses

successful

Bodyapplication/json

postobject

metaobject

Response

application/json

{
  "post": {
    "id": 0,
    "title": "string",
    "description": "string",
    "slug": "string",
    "image_url": "string",
    "active": true,
    "application_theme_template_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "countries": [ … ],
    "custom_slug": true,
    "use_search_engine": true,
    "show_on_site_search": false,
    "post_date": "2021-01-01",
    "post_author": "John Doe",
    "summary": "This is a summary of the post",
    "preview_url": "https://example.com/preview",
    "category": { … },
    "collections": [ … ],
    "search_engine_optimizer": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a post

Request

Delete a post (hard delete)

Path

idintegerrequired

Post ID

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

Responses

successful

Bodyapplication/json

postobject

metaobject

Response

application/json

{
  "post": {
    "id": 0,
    "title": "string",
    "description": "string",
    "slug": "string",
    "image_url": "string",
    "active": true,
    "application_theme_template_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "countries": [ … ],
    "custom_slug": true,
    "use_search_engine": true,
    "show_on_site_search": false,
    "post_date": "2021-01-01",
    "post_author": "John Doe",
    "summary": "This is a summary of the post",
    "preview_url": "https://example.com/preview"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

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

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

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

idintegerrequired

user_idinteger or null

titlestringrequired

descriptionobject or null

strippedstring or null

media_typestringrequired

Enum"share""update""training""upload"

media_formatstring or null

image_urlstring or null

video_urlstring or null

pdf_urlstring or null

kindstring or null

activebooleanrequired

visibilityinteger or null

share_linkstring or null

preview_linkstring or null

viewsintegerrequired

leadsintegerrequired

watchobject or null

video_statusstring or null

durationinteger or null

cta_urlstring or null

cta_button_textstring or null

cta_enabledbooleanrequired

cta_action_typestring or null

video_shopping_enabledbooleanrequired

prompts_enabledbooleanrequired

ranksArray of strings

settingsobject or null

application_theme_template_idinteger or null

created_atstring(date-time)required

subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects

tagsArray of objects

slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects

commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response

application/json

{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}