POST /v1/lists | Verifier

Family: Lists and collaboration · Operation ID: v1_create_list

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open lists

Required scope: lists

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X POST "$API_BASE_URL/v1/lists" \
  -H "Authorization: Bearer $API_KEY" \
  -F "[email protected]"

Request body · multipart/form-data

{
  "$ref": "#/components/schemas/ListUploadRequest",
  "definition": {
    "properties": {
      "email_column": {
        "nullable": true,
        "type": "string"
      },
      "file": {
        "format": "binary",
        "type": "string"
      },
      "name": {
        "nullable": true,
        "type": "string"
      },
      "source_key": {
        "description": "Optional source key used for source quality analytics, for example apollo, hubspot, salesforce, signup_form, csv_vendor.",
        "nullable": true,
        "type": "string"
      }
    },
    "required": [
      "file"
    ],
    "type": "object"
  }
}

Responses

202

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ListUploadResponse"
      }
    }
  },
  "description": "List upload accepted"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract