Prompts

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}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

List all prompts for a relateable object

Request

Get a list of prompts for a specific Page, Medium, Product, or Promotion

Query
relateable_typestringrequired

Type of the relateable object. Can be 'Page', 'Medium', 'Product', or 'Promotion'.

Enum"Page""Medium""Product""Promotion"
relateable_idintegerrequired

ID of the relateable object

pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 20
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/prompts?page=1&per_page=20&relateable_id=0&relateable_type=Page' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
promptsArray of objects
metaobject
Response
application/json
{
  "prompts": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "total_count": 42,
    "total_pages": 3,
    "current_page": 1
  }
}

Create a prompt

Request

Create a new prompt associated with a Page, Medium, Product, or Promotion

Bodyapplication/jsonrequired

Prompt details with relateable info. A prompt must be associated with a Page, Medium, Product, or Promotion.

relateable_typestringrequired

Type of entity this prompt is related to. Can be 'Page', 'Medium', 'Product', or 'Promotion'

Enum"Page""Medium""Product""Promotion"
Example: "Page"
relateable_idintegerrequired

ID of the entity this prompt is related to

Example: 1
promptobjectrequired
prompt.​titlestringrequired

Title of the prompt

Example: "Social Media"
prompt.​contentstringrequired

Content of the prompt

Example: "Check out this product"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/prompts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "relateable_type": "Page",
    "relateable_id": 1,
    "prompt": {
      "title": "Social Media",
      "content": "Check out this product"
    }
  }'

Responses

prompt created

Bodyapplication/json
promptobject
metaobject
Response
application/json
{
  "prompt": {
    "id": 1,
    "title": "Social Media",
    "content": "Check out this product"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update a prompt

Request

Update an existing prompt's title and content

Path
idintegerrequired

ID of the prompt

Bodyapplication/jsonrequired

Prompt details to update

promptobjectrequired
prompt.​titlestringrequired
prompt.​contentstringrequired
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/prompts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "prompt": {
      "title": "string",
      "content": "string"
    }
  }'

Responses

prompt updated

Bodyapplication/json
promptobject
metaobject
Response
application/json
{
  "prompt": {
    "id": 1,
    "title": "Social Media",
    "content": "Check out this product"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Delete a prompt

Request

Delete an existing prompt

Path
idintegerrequired

ID of the prompt

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

Responses

prompt deleted

Bodyapplication/json
successboolean

Indicates whether the operation was successful

Example: true
metaobject
Response
application/json
{
  "success": true,
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{
  "droplet_categories": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}