Company Popups
/
Delete a popup

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

Get a list of popups

Request

Query
filterrific[sorted_by]string

Sort option (created_at_desc, title_asc, etc.)

filterrific[search_query]string

Search term

filterrific[by_status]string

Filter by status (active/inactive)

filterrific[by_type]string

Filter by popup type

filterrific[by_event]string

Filter by event

pageinteger

Page number for pagination

per_pageinteger

Items per page for pagination

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/popups?filterrific%5Bby_event%5D=string&filterrific%5Bby_status%5D=string&filterrific%5Bby_type%5D=string&filterrific%5Bsearch_query%5D=string&filterrific%5Bsorted_by%5D=string&page=0&per_page=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
arrays
Response
application/json
[]

Create a popup

Request

Bodyapplication/json
popupobjectrequired
popup.​titlestringrequired
Example: "Welcome Popup"
popup.​descriptionstring
Example: "<p>Welcome to our site!</p>"
popup.​eventstringrequired
Example: "page_load"
popup.​popup_typestringrequired
Example: "modal"
popup.​secondsinteger
Example: 5
popup.​globalboolean
Example: true
popup.​activeboolean
Example: true
popup.​button_textstringrequired
Example: "Close"
popup.​button_redirectstring
Example: "https://example.com"
popup.​background_colorstringrequired
Example: "#ffffff"
popup.​text_colorstringrequired
Example: "#000000"
popup.​button_colorstringrequired
Example: "#007bff"
popup.​button_text_colorstringrequired
Example: "#ffffff"
popup.​button_actionstring
Example: "redirect"
popup.​display_success_messageboolean
Example: true
popup.​success_message_typestring
Example: "system_message"
popup.​message_titlestring
Example: "Thank you!"
popup.​message_bodystring
Example: "Your information has been submitted."
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/popups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "popup": {
      "title": "Welcome Popup",
      "description": "<p>Welcome to our site!</p>",
      "event": "page_load",
      "popup_type": "modal",
      "seconds": 5,
      "global": true,
      "active": true,
      "button_text": "Close",
      "button_redirect": "https://example.com",
      "background_color": "#ffffff",
      "text_color": "#000000",
      "button_color": "#007bff",
      "button_text_color": "#ffffff",
      "button_action": "redirect",
      "display_success_message": true,
      "success_message_type": "system_message",
      "message_title": "Thank you!",
      "message_body": "Your information has been submitted."
    }
  }'

Responses

popup created

Bodyapplication/json
idinteger
titlestring
descriptionobject
headerstring or null
image_urlstring or null
image_pathstring or null
eventstring
popup_typestring
secondsinteger
globalboolean
activeboolean
button_textstring
button_redirectstring or null
email_subjectstring or null
email_bodyobject
background_colorstring
text_colorstring
button_colorstring
button_text_colorstring
button_actionstring
tokenstring
class_name_triggerstring
display_success_messageboolean
success_message_typestring or null
message_titlestring or null
message_bodystring or null
companyobject
followableobject or null
pathsArray of arrays
leadsArray of arrays
Response
application/json
{
  "id": 0,
  "title": "string",
  "description": {},
  "header": "string",
  "image_url": "string",
  "image_path": "string",
  "event": "string",
  "popup_type": "string",
  "seconds": 0,
  "global": true,
  "active": true,
  "button_text": "string",
  "button_redirect": "string",
  "email_subject": "string",
  "email_body": {},
  "background_color": "string",
  "text_color": "string",
  "button_color": "string",
  "button_text_color": "string",
  "button_action": "string",
  "token": "string",
  "class_name_trigger": "string",
  "display_success_message": true,
  "success_message_type": "string",
  "message_title": "string",
  "message_body": "string",
  "company": {},
  "followable": {},
  "paths": [],
  "leads": []
}

Get a specific popup

Request

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

Responses

successful

Bodyapplication/json
idinteger
titlestring
descriptionobject
headerstring or null
image_urlstring or null
image_pathstring or null
eventstring
popup_typestring
secondsinteger
globalboolean
activeboolean
button_textstring
button_redirectstring or null
email_subjectstring or null
email_bodyobject
background_colorstring
text_colorstring
button_colorstring
button_text_colorstring
button_actionstring
tokenstring
class_name_triggerstring
display_success_messageboolean
success_message_typestring or null
message_titlestring or null
message_bodystring or null
companyobject
followableobject or null
pathsArray of arrays
leadsArray of arrays
Response
application/json
{
  "id": 0,
  "title": "string",
  "description": {},
  "header": "string",
  "image_url": "string",
  "image_path": "string",
  "event": "string",
  "popup_type": "string",
  "seconds": 0,
  "global": true,
  "active": true,
  "button_text": "string",
  "button_redirect": "string",
  "email_subject": "string",
  "email_body": {},
  "background_color": "string",
  "text_color": "string",
  "button_color": "string",
  "button_text_color": "string",
  "button_action": "string",
  "token": "string",
  "class_name_trigger": "string",
  "display_success_message": true,
  "success_message_type": "string",
  "message_title": "string",
  "message_body": "string",
  "company": {},
  "followable": {},
  "paths": [],
  "leads": []
}

Update a popup

Request

Path
idstringrequired
Bodyapplication/json
popupobjectrequired
popup.​titlestring
Example: "Updated Popup"
popup.​descriptionstring
Example: "<p>Updated content!</p>"
popup.​activeboolean
Example: false
popup.​globalboolean
Example: false
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/popups/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "popup": {
      "title": "Updated Popup",
      "description": "<p>Updated content!</p>",
      "active": false,
      "global": false
    }
  }'

Responses

popup updated

Bodyapplication/json
idinteger
titlestring
descriptionobject
headerstring or null
image_urlstring or null
image_pathstring or null
eventstring
popup_typestring
secondsinteger
globalboolean
activeboolean
button_textstring
button_redirectstring or null
email_subjectstring or null
email_bodyobject
background_colorstring
text_colorstring
button_colorstring
button_text_colorstring
button_actionstring
tokenstring
class_name_triggerstring
display_success_messageboolean
success_message_typestring or null
message_titlestring or null
message_bodystring or null
companyobject
followableobject or null
pathsArray of arrays
leadsArray of arrays
Response
application/json
{
  "id": 0,
  "title": "string",
  "description": {},
  "header": "string",
  "image_url": "string",
  "image_path": "string",
  "event": "string",
  "popup_type": "string",
  "seconds": 0,
  "global": true,
  "active": true,
  "button_text": "string",
  "button_redirect": "string",
  "email_subject": "string",
  "email_body": {},
  "background_color": "string",
  "text_color": "string",
  "button_color": "string",
  "button_text_color": "string",
  "button_action": "string",
  "token": "string",
  "class_name_trigger": "string",
  "display_success_message": true,
  "success_message_type": "string",
  "message_title": "string",
  "message_body": "string",
  "company": {},
  "followable": {},
  "paths": [],
  "leads": []
}

Delete a popup

Request

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

Responses

popup deleted

Bodyapplication/json
string
Response
application/json
"string"

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

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