---
title: "Create an External Batch Provider"
method: POST
path: "/v1/batch/providers"
tags: ["Batch"]
---

# Create an External Batch Provider

`POST /v1/batch/providers`

Register an HTTPS external enrichment provider.

## Request body

- object
  - `name` string, required — Display name for the provider.
  - `baseUrl` string, uri, required — HTTPS endpoint to call. Private IP addresses are rejected.
  - `authType` 'api_key' | 'bearer' | 'header', required — How the credential is presented to the provider.
  - `authCredentialName` string, required — Header or parameter name carrying the credential.
  - `authCredentialValue` string, required — Credential value. Redacted in every response.
  - `defaultMethod` 'GET' | 'POST' — HTTP method used for provider calls.
  - `defaultHeaders` object — Extra headers sent with every provider call.
  - `rateLimitRpm` integer — Requests per minute ceiling for this provider.
  - `responseMapping` object — Maps provider response fields onto LeadMagic output columns.
  - `healthCheckUrl` string, uri — URL polled to determine provider health.
  - `healthCheckExpectedStatus` integer — HTTP status treated as healthy.

## Response `201`

Provider created with credentials redacted.

## Other responses

- `400` — Bad Request - The request was malformed or contains invalid parameters. **Common causes:** - Missing required fields - Invalid field format (e.g., malformed email) - Invalid JSON syntax - Invalid parameter values
- `401` — Unauthorized - Authentication failed. **Common causes:** - Missing X-API-Key header - Invalid or expired API key - Malformed API key

---

[API](https://skmtc.net/leadmagic/apis/leadmagic-api.md) · [All operations](https://skmtc.net/leadmagic/apis/leadmagic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leadmagic/leadmagic-api/revisions/aa19cf9bc46a/schema)