Users
/
Append metadata field

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

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

Creates a user

Request

Bodyapplication/json
country_codestringrequired
language_codestringrequired
userobjectrequired
user.​emailstringrequired
user.​first_namestring
user.​last_namestring
user.​passwordstring
user.​avatarstring
user.​phonestring
user.​google_idstring
user.​biostring
user.​facebookstring
user.​instagramstring
user.​twitterstring
user.​linkedinstring
user.​whatsappstring
user.​wechatstring
user.​youtubestring
user.​zip_codestring
user.​dobstring(date)
user.​genderstring
user.​time_zonestring
user.​push_notificationsboolean
user.​email_notificationsboolean
user.​sms_notificationsboolean
user.​external_idstring
user.​usernamestring
user.​activeboolean
user.​affiliateobjectrequired
user.​affiliate.​idstring
user.​affiliate.​external_idstring
user.​affiliate.​usernamestring
user.​affiliate.​emailstring
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "country_code": "string",
    "language_code": "string",
    "user": {
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "password": "string",
      "avatar": "string",
      "phone": "string",
      "google_id": "string",
      "bio": "string",
      "facebook": "string",
      "instagram": "string",
      "twitter": "string",
      "linkedin": "string",
      "whatsapp": "string",
      "wechat": "string",
      "youtube": "string",
      "zip_code": "string",
      "dob": "2019-08-24",
      "gender": "string",
      "time_zone": "string",
      "push_notifications": true,
      "email_notifications": true,
      "sms_notifications": true,
      "external_id": "string",
      "username": "string",
      "active": true,
      "affiliate": {
        "id": "string",
        "external_id": "string",
        "username": "string",
        "email": "string"
      }
    }
  }'

Responses

user created successfully

Bodyapplication/json
user_companyobject(UserCompany)required
user_company.​idintegerrequired
user_company.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​image_urlstring or null

User's image URL

Example: "https://example.com/image.jpg"
user_company.​company_idinteger or nullrequired

ID of the company the user belongs to

Example: 42
user_company.​external_idstring or nullrequired

External identifier for the user

Example: "EXT123456"
user_company.​usernamestring or nullrequired

User's unique username within the company

Example: "johny_jobs"
user_company.​activebooleanrequired

Whether the user is active in the company

Default true
Example: true
user_company.​mysite_urlstring or nullrequired

URL to the user's personal site

Example: "https://mycompany.com/johny_jobs"
user_company.​rankinteger or nullrequired

External ID of Rank the User is linked to

Example: "234234"
user_company.​share_guidstring or nullrequired

Unique identifier for sharing content

Example: "a6848f0b"
user_company.​legacy_numberstring or nullrequired

User's legacy phone number

Example: "+18001234567"
user_company.​affiliateobject or nullrequired

User's affiliate information

Example: "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}"
user_company.​userobject(User)required
user_company.​user.​idintegerrequired
user_company.​user.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​user.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​user.​emailstring or nullrequired

User's email address

Example: "john@example.com"
user_company.​user.​avatarstring or nullrequired

User's avatar URL

Example: "https://example.com/avatar.jpg"
user_company.​user.​phonestring or nullrequired

User's phone

Example: "+18018888888"
user_company.​user.​google_idstring or nullrequired

User's Google Id

Example: ""
user_company.​user.​biostring or nullrequired

User's Bio

Example: "Software engineer passionate about creating intuitive user experiences"
user_company.​user.​facebookstring or nullrequired

User's Facebook profile URL

Example: "https://facebook.com/johndoe"
user_company.​user.​instagramstring or nullrequired

User's Instagram handle

Example: "johndoe_insta"
user_company.​user.​twitterstring or nullrequired

User's Twitter/X handle

Example: "johndoe_tweets"
user_company.​user.​linkedinstring or nullrequired

User's LinkedIn profile URL

Example: "https://linkedin.com/in/johndoe"
user_company.​user.​whatsappstring or nullrequired

User's WhatsApp number

Example: "+18019999999"
user_company.​user.​wechatstring or nullrequired

User's WeChat ID

Example: "johndoe_wechat"
user_company.​user.​youtubestring or nullrequired

User's YouTube channel URL

Example: "https://youtube.com/channel/UC123abc456def"
user_company.​user.​zip_codestring or nullrequired

User's ZIP/postal code

Example: "84102"
user_company.​user.​dobstring or nullrequired

User's date of birth

Example: "1990-05-15"
user_company.​user.​genderstring or nullrequired

User's gender

Example: "male"
user_company.​user.​time_zonestring or nullrequired

User's time zone

Example: "America/New_York"
user_company.​user.​dndstring or nullrequired

User's Do Not Disturb preference

Default "off"
Example: "true"
user_company.​user.​languageobject(Language)required
user_company.​user.​language.​idintegerrequired
user_company.​user.​language.​namestring or null
Example: "English"
user_company.​user.​language.​isostring or null
Example: "en"
user_company.​user.​countryobject or null(Country)
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "user_company": {
    "id": 0,
    "first_name": "John",
    "last_name": "Doe",
    "image_url": "https://example.com/image.jpg",
    "company_id": 42,
    "external_id": "EXT123456",
    "username": "johny_jobs",
    "active": true,
    "mysite_url": "https://mycompany.com/johny_jobs",
    "rank": "234234",
    "share_guid": "a6848f0b",
    "legacy_number": "+18001234567",
    "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}",
    "user": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get users with optional filters

Request

Query
search_querystring

Filter users with search query that matches with their first name or last name

sorted_bystring

Sort the records by one of the supported attributes:

  • first_name

The sort attribute should be followed by one of the order directives: '_asc', '_desc'

Example: sorted_by=first_name_asc
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 50
by_metadatastring(json)

Search JSON meta data

Default "{}"
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/users?by_metadata={}&page=1&per_page=50&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

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

Retrieves a user

Request

Path
idstringrequired

User ID or auth token

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

Responses

user found via auth token

Bodyapplication/json
user_companyobject(UserCompany)required
user_company.​idintegerrequired
user_company.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​image_urlstring or null

User's image URL

Example: "https://example.com/image.jpg"
user_company.​company_idinteger or nullrequired

ID of the company the user belongs to

Example: 42
user_company.​external_idstring or nullrequired

External identifier for the user

Example: "EXT123456"
user_company.​usernamestring or nullrequired

User's unique username within the company

Example: "johny_jobs"
user_company.​activebooleanrequired

Whether the user is active in the company

Default true
Example: true
user_company.​mysite_urlstring or nullrequired

URL to the user's personal site

Example: "https://mycompany.com/johny_jobs"
user_company.​rankinteger or nullrequired

External ID of Rank the User is linked to

Example: "234234"
user_company.​share_guidstring or nullrequired

Unique identifier for sharing content

Example: "a6848f0b"
user_company.​legacy_numberstring or nullrequired

User's legacy phone number

Example: "+18001234567"
user_company.​affiliateobject or nullrequired

User's affiliate information

Example: "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}"
user_company.​userobject(User)required
user_company.​user.​idintegerrequired
user_company.​user.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​user.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​user.​emailstring or nullrequired

User's email address

Example: "john@example.com"
user_company.​user.​avatarstring or nullrequired

User's avatar URL

Example: "https://example.com/avatar.jpg"
user_company.​user.​phonestring or nullrequired

User's phone

Example: "+18018888888"
user_company.​user.​google_idstring or nullrequired

User's Google Id

Example: ""
user_company.​user.​biostring or nullrequired

User's Bio

Example: "Software engineer passionate about creating intuitive user experiences"
user_company.​user.​facebookstring or nullrequired

User's Facebook profile URL

Example: "https://facebook.com/johndoe"
user_company.​user.​instagramstring or nullrequired

User's Instagram handle

Example: "johndoe_insta"
user_company.​user.​twitterstring or nullrequired

User's Twitter/X handle

Example: "johndoe_tweets"
user_company.​user.​linkedinstring or nullrequired

User's LinkedIn profile URL

Example: "https://linkedin.com/in/johndoe"
user_company.​user.​whatsappstring or nullrequired

User's WhatsApp number

Example: "+18019999999"
user_company.​user.​wechatstring or nullrequired

User's WeChat ID

Example: "johndoe_wechat"
user_company.​user.​youtubestring or nullrequired

User's YouTube channel URL

Example: "https://youtube.com/channel/UC123abc456def"
user_company.​user.​zip_codestring or nullrequired

User's ZIP/postal code

Example: "84102"
user_company.​user.​dobstring or nullrequired

User's date of birth

Example: "1990-05-15"
user_company.​user.​genderstring or nullrequired

User's gender

Example: "male"
user_company.​user.​time_zonestring or nullrequired

User's time zone

Example: "America/New_York"
user_company.​user.​dndstring or nullrequired

User's Do Not Disturb preference

Default "off"
Example: "true"
user_company.​user.​languageobject(Language)required
user_company.​user.​language.​idintegerrequired
user_company.​user.​language.​namestring or null
Example: "English"
user_company.​user.​language.​isostring or null
Example: "en"
user_company.​user.​countryobject or null(Country)
metaobject
Response
application/json
{
  "user_company": {
    "id": 0,
    "first_name": "John",
    "last_name": "Doe",
    "image_url": "https://example.com/image.jpg",
    "company_id": 42,
    "external_id": "EXT123456",
    "username": "johny_jobs",
    "active": true,
    "mysite_url": "https://mycompany.com/johny_jobs",
    "rank": "234234",
    "share_guid": "a6848f0b",
    "legacy_number": "+18001234567",
    "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}",
    "user": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Updates a user

Request

Path
idstringrequired

User ID or auth token

Bodyapplication/json
userobjectrequired
user.​emailstringrequired
user.​first_namestring
user.​last_namestring
user.​passwordstring
user.​avatarstring
user.​phonestring
user.​google_idstring
user.​biostring
user.​facebookstring
user.​instagramstring
user.​twitterstring
user.​linkedinstring
user.​whatsappstring
user.​wechatstring
user.​youtubestring
user.​zip_codestring
user.​dobstring(date)
user.​genderstring
user.​time_zonestring
user.​push_notificationsboolean
user.​email_notificationsboolean
user.​sms_notificationsboolean
user.​external_idstring
user.​usernamestring
user.​activeboolean
user.​affiliateobjectrequired
user.​affiliate.​idstring
user.​affiliate.​external_idstring
user.​affiliate.​usernamestring
user.​affiliate.​emailstring
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/users/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "password": "string",
      "avatar": "string",
      "phone": "string",
      "google_id": "string",
      "bio": "string",
      "facebook": "string",
      "instagram": "string",
      "twitter": "string",
      "linkedin": "string",
      "whatsapp": "string",
      "wechat": "string",
      "youtube": "string",
      "zip_code": "string",
      "dob": "2019-08-24",
      "gender": "string",
      "time_zone": "string",
      "push_notifications": true,
      "email_notifications": true,
      "sms_notifications": true,
      "external_id": "string",
      "username": "string",
      "active": true,
      "affiliate": {
        "id": "string",
        "external_id": "string",
        "username": "string",
        "email": "string"
      }
    }
  }'

Responses

update via auth token

Bodyapplication/json
user_companyobject(UserCompany)required
user_company.​idintegerrequired
user_company.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​image_urlstring or null

User's image URL

Example: "https://example.com/image.jpg"
user_company.​company_idinteger or nullrequired

ID of the company the user belongs to

Example: 42
user_company.​external_idstring or nullrequired

External identifier for the user

Example: "EXT123456"
user_company.​usernamestring or nullrequired

User's unique username within the company

Example: "johny_jobs"
user_company.​activebooleanrequired

Whether the user is active in the company

Default true
Example: true
user_company.​mysite_urlstring or nullrequired

URL to the user's personal site

Example: "https://mycompany.com/johny_jobs"
user_company.​rankinteger or nullrequired

External ID of Rank the User is linked to

Example: "234234"
user_company.​share_guidstring or nullrequired

Unique identifier for sharing content

Example: "a6848f0b"
user_company.​legacy_numberstring or nullrequired

User's legacy phone number

Example: "+18001234567"
user_company.​affiliateobject or nullrequired

User's affiliate information

Example: "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}"
user_company.​userobject(User)required
user_company.​user.​idintegerrequired
user_company.​user.​first_namestring or nullrequired

User's first name

Example: "John"
user_company.​user.​last_namestring or nullrequired

User's last name

Example: "Doe"
user_company.​user.​emailstring or nullrequired

User's email address

Example: "john@example.com"
user_company.​user.​avatarstring or nullrequired

User's avatar URL

Example: "https://example.com/avatar.jpg"
user_company.​user.​phonestring or nullrequired

User's phone

Example: "+18018888888"
user_company.​user.​google_idstring or nullrequired

User's Google Id

Example: ""
user_company.​user.​biostring or nullrequired

User's Bio

Example: "Software engineer passionate about creating intuitive user experiences"
user_company.​user.​facebookstring or nullrequired

User's Facebook profile URL

Example: "https://facebook.com/johndoe"
user_company.​user.​instagramstring or nullrequired

User's Instagram handle

Example: "johndoe_insta"
user_company.​user.​twitterstring or nullrequired

User's Twitter/X handle

Example: "johndoe_tweets"
user_company.​user.​linkedinstring or nullrequired

User's LinkedIn profile URL

Example: "https://linkedin.com/in/johndoe"
user_company.​user.​whatsappstring or nullrequired

User's WhatsApp number

Example: "+18019999999"
user_company.​user.​wechatstring or nullrequired

User's WeChat ID

Example: "johndoe_wechat"
user_company.​user.​youtubestring or nullrequired

User's YouTube channel URL

Example: "https://youtube.com/channel/UC123abc456def"
user_company.​user.​zip_codestring or nullrequired

User's ZIP/postal code

Example: "84102"
user_company.​user.​dobstring or nullrequired

User's date of birth

Example: "1990-05-15"
user_company.​user.​genderstring or nullrequired

User's gender

Example: "male"
user_company.​user.​time_zonestring or nullrequired

User's time zone

Example: "America/New_York"
user_company.​user.​dndstring or nullrequired

User's Do Not Disturb preference

Default "off"
Example: "true"
user_company.​user.​languageobject(Language)required
user_company.​user.​language.​idintegerrequired
user_company.​user.​language.​namestring or null
Example: "English"
user_company.​user.​language.​isostring or null
Example: "en"
user_company.​user.​countryobject or null(Country)
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "user_company": {
    "id": 0,
    "first_name": "John",
    "last_name": "Doe",
    "image_url": "https://example.com/image.jpg",
    "company_id": 42,
    "external_id": "EXT123456",
    "username": "johny_jobs",
    "active": true,
    "mysite_url": "https://mycompany.com/johny_jobs",
    "rank": "234234",
    "share_guid": "a6848f0b",
    "legacy_number": "+18001234567",
    "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}",
    "user": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Deletes a user

Request

Path
idstringrequired

User ID or auth token

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

Responses

user deleted successfully

Bodyapplication/json
idintegerrequired

User ID

Example: 1
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 1,
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Append metadata field

Request

Path
idstringrequired

User ID or auth token

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure.

Example: {"profile_complete":true,"preferences":{"theme":"dark","newsletter":true}}
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/users/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "profile_complete": true,
      "preferences": {
        "theme": "dark",
        "newsletter": true
      }
    }
  }'

Responses

success

Bodyapplication/json
user_companyobject(UserCompany)
metaobject
Response
application/json
{
  "user_company": {
    "id": 0,
    "first_name": "John",
    "last_name": "Doe",
    "image_url": "https://example.com/image.jpg",
    "company_id": 42,
    "external_id": "EXT123456",
    "username": "johny_jobs",
    "active": true,
    "mysite_url": "https://mycompany.com/johny_jobs",
    "rank": "234234",
    "share_guid": "a6848f0b",
    "legacy_number": "+18001234567",
    "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}",
    "user": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Finds a user

Request

Find user using one of it's identifiers

Query
external_idstring

User's external id

usernamestring

User's username

emailstring

User's email

tokenstring

User's auth token

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/users/find?email=string&external_id=string&token=string&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

user found

Bodyapplication/json
idintegerrequired

User ID

Example: 1
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 1,
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

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