pipeline

Upload a weekly bulk file for a portal-download state (e.g. TX)

Validate and stage a manually downloaded SOS bulk file.

Accepts the original .zip from the portal (CW….zip fixed-width, or BFD_W….zip JSON shards) or the unzipped .txt / .json. Validates the file against the state's data contract (fixed-width line length, presence of entity records) and rejects look-alike products — e.g. uploading the TX comma-delimited "List" CSV fails here with a clear message instead of failing mid-pipeline.

Returns input_file: pass it to POST /api/v1/pipeline/trigger along with a stage list that includes pull.

post/api/v1/pipeline/upload-bulk-file

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/pipeline/upload-bulk-file
  • Auth: API key in header X-API-Key

Response

Successful Response

input_filestring required
filenamestring required
statestring required
entity_countinteger required
line_countinteger required
size_bytesinteger required
repaired_line_countinteger

Changes

No recorded changes to this operation across all 1 revision of this API.