Lead

Storefront Lead API endpoints

Endpoints

POST/leads

Store the shop lead

POST /leads

Store the shop lead.

Request body

Store lead body

emailoptionalstring

first_nameoptionalstring

last_nameoptionalstring

metadataoptionalobject

ReturnsLead

Lead object response

Error responses

402object

The merchant account has no payment method, so the shop cannot accept leads (payment_method_required).

422object

email is missing, is not a valid email, is longer than 255 characters, or is already a lead of this shop. first_name or last_name is not a string or is longer than 255 characters. metadata is not an object or has more than 50 keys.

429object

The lead rate limit is reached: 5 requests per hour from one IP address, or 100 per hour or 1000 per day for the shop.

curl -X POST https://api.subbly.co/storefront/v1/leads \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email",
  "first_name": "first_name",
  "last_name": "last_name",
  "metadata": {
    "survey_id": 1,
    "answers": {
      "id": 1,
      "content": "red"
    }
  }
}'

Response

{
  "id": 1,
  "email": "test@test.co",
  "first_name": "John",
  "last_name": "Doe",
  "user_agent": "127.0.0.1",
  "ip_address": "PostmanRuntime/7.33.0",
  "metadata": {
    "survey_id": 1,
    "answers": {
      "id": 1,
      "content": "red"
    }
  }
}