Forms
/
Respond to a form

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://fluid-commerce.redocly.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

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

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

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

List forms

Request

List all forms for a company

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

Responses

successful

Bodyapplication/json
dataArray of objects
paginationobject
filtersobject
Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 0,
    "total_count": 0
  },
  "filters": {
    "sorted_by": [ … ]
  }
}

Create a form

Request

Create a new form

Bodyapplication/json
titlestringrequired

Title of the form

Example: "New Form"
descriptionstring

Description of the form

Example: "Form description"
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/forms \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "New Form",
    "description": "Form description"
  }'

Responses

created

Bodyapplication/json
messagestring
formobject
Response
application/json
{
  "message": "string",
  "form": {
    "id": 0,
    "countries": [ … ],
    "description": "string",
    "form_components": "string",
    "form_redirect": "string",
    "form_respondents_count": 0,
    "form_type": "string",
    "status": "string",
    "title": "string",
    "updated_at": "string"
  }
}

List form respondents

Request

List all respondents for a form

Path
idintegerrequired

Form ID

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

Responses

successful

Bodyapplication/json
dataArray of objects
paginationobject
filtersobject
Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 0,
    "total_count": 0
  },
  "filters": {
    "sorted_by": [ … ]
  }
}

Respond to a form

Request

Respond to a form

Path
idintegerrequired

Form ID

Bodyapplication/json
form_responseobjectrequired
form_response.​contactobject
form_response.​responsesArray of objects
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/forms/{id}/respond' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "form_response": {
      "contact": {
        "first_name": "string",
        "last_name": "string",
        "email": "string"
      },
      "responses": [
        {
          "form_element_id": 0,
          "answer": "string"
        }
      ]
    }
  }'

Responses

created

Bodyapplication/json
messagestring
responsesArray of objects
Response
application/json
{
  "message": "string",
  "responses": [
    { … }
  ]
}

Get form statistics

Request

Get statistics for a form

Query
idintegerrequired

Form ID

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/forms/statistics?id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
total_formsinteger
total_responsesinteger
completed_responsesinteger
completion_ratenumber(float)
today_responsesinteger
yesterday_responsesinteger
Response
application/json
{
  "total_forms": 0,
  "total_responses": 0,
  "completed_responses": 0,
  "completion_rate": 0.1,
  "today_responses": 0,
  "yesterday_responses": 0
}

Send form via email

Request

Send a form via email

Path
idintegerrequired

Form ID

Bodyapplication/json
emailstringrequired

Email address to send the form to

Example: "user@example.com"
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/forms/{id}/send_mail' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com"
  }'

Responses

email sent

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "string"
}

Delete a form

Request

Delete a form

Path
idintegerrequired

Form ID

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

Responses

deleted

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "string"
}

Duplicate a form

Request

Duplicate a form

Path
idintegerrequired

Form ID

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/forms/{id}/duplicate' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

duplicated with different id

Bodyapplication/json
idinteger
countriesArray of objects
descriptionstring or null
form_componentsstring or null
form_redirectstring or null
form_respondents_countinteger
form_typestring
statusstring
titlestring
updated_atstring(date_time)
Response
application/json
{
  "id": 0,
  "countries": [
    { … }
  ],
  "description": "string",
  "form_components": "string",
  "form_redirect": "string",
  "form_respondents_count": 0,
  "form_type": "string",
  "status": "string",
  "title": "string",
  "updated_at": "string"
}

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations