lead

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://fluid-commerce.redocly.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

events

Operations

lead

Operations

Save a new lead capture

Request

Bodyapplication/json
leadobject(Lead)required
lead.​messagestringrequired
Example: "How are you?"
lead.​contactContactEmail (object) or ContactPhone (object)(Contact)required
Any of:
lead.​contact.​namestringrequired
Example: "John Doe"
lead.​contact.​emailstring(email)required
Example: "john@example.com"
lead.​contact.​phonestring(phone)
Example: "+1 (800) 555-1234"
pageobject(Page)
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​fluid_journeystring
metadata.​attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)
Any of:
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/events/leads/capture \
  -H 'Content-Type: application/json' \
  -d '{
    "lead": {
      "message": "How are you?",
      "contact": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+1 (800) 555-1234"
      }
    },
    "page": {
      "url": "https://www.example.com/page",
      "title": "Example Page",
      "description": "This is an example page",
      "image": "https://www.example.com/page.jpg"
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

lead captured

Bodyapplication/json
statusnumberrequired
Example: 201
metadataobject(ResponseMetadata)required
Example: {"fluid_shop":"myshop","fluid_session":"fs_szwdDuRbqEe7AV7sXk7vVq","request_uuid":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-01-01T00:00:00Z"}
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstringrequired
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
metadata.​timestampstringrequired
Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "status": 201,
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

page

Operations

fingerprint

Operations

session

Operations

settings

Operations