POST /v1/bulk | Verifier

Family: Bulk and observability · Operation ID: v1_create_bulk_job

Access

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

Open bulk jobs

Required scope: bulk

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/bulk" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Parameters

[
  {
    "description": "Optional idempotency key",
    "in": "header",
    "name": "Idempotency-Key",
    "required": false,
    "schema": {
      "nullable": true,
      "type": "string"
    }
  }
]

Request body · application/json

{
  "$ref": "#/components/schemas/BulkCreateRequest",
  "definition": {
    "properties": {
      "input": {
        "items": {
          "format": "email",
          "type": "string"
        },
        "type": "array"
      },
      "source": {
        "description": "Alias for source_key.",
        "nullable": true,
        "type": "string"
      },
      "source_key": {
        "description": "Optional source key used for source quality analytics.",
        "nullable": true,
        "type": "string"
      },
      "webhook": {
        "additionalProperties": true,
        "nullable": true,
        "type": "object"
      }
    },
    "required": [
      "input"
    ],
    "type": "object"
  }
}

Responses

200

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BulkCreateResponse"
      }
    }
  },
  "description": "Bulk job created"
}

default

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

Download the full OpenAPI contract