Sign in

v6

latestOpenAPI 3.1.02026-08-068648296.2 KB
Batch

Create an External Batch Provider

Register an HTTPS external enrichment provider.

post/v1/batch/providers

Request body

namestring required

Display name for the provider.

baseUrlstring 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.

authCredentialNamestring required

Header or parameter name carrying the credential.

authCredentialValuestring required

Credential value. Redacted in every response.

defaultMethod'GET' | 'POST'

HTTP method used for provider calls.

defaultHeadersobject

Extra headers sent with every provider call.

rateLimitRpminteger

Requests per minute ceiling for this provider.

responseMappingobject

Maps provider response fields onto LeadMagic output columns.

healthCheckUrlstring uri

URL polled to determine provider health.

healthCheckExpectedStatusinteger

HTTP status treated as healthy.

Example request

{
  "name": "acme-enrichment",
  "baseUrl": "https://api.acme.com/enrich",
  "authCredentialName": "X-API-Key",
  "healthCheckExpectedStatus": 200
}

Response

Provider created with credentials redacted.