commerce
commerce

Comp List

Build the cohort's workbook and deliver it FREE through the comp door.

Admin-only. Resolves the cohort exactly as a sale would, builds the customer workbook through the one gated builder, uploads it, and writes the same ledger rows POST /commerce/comp-deliver writes (customer find-or-create, hidden $0 product carrying the filter so "Sell this again" works, one Order with status='comp', one Export with a durable token). Then emails the recipient with evaluation wording. The Run Manifest records exactly what shipped (order.run_manifest_id), same as a paid order.

Nothing is written if the file can't be built: a gate refusal or an empty cohort returns 422 and leaves no order behind.

post/api/v1/commerce/comp-list

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/commerce/comp-list
  • Auth: API key in header X-API-Key

Request body

labelstring required
statestring nullable
filtersobject[]
entity_idsstring[] nullable
lead_countinteger nullable
audiencestring
buyer_emailstring required
buyer_namestring nullable
notestring nullable

Response

Successful Response

order_idstring required
record_countinteger required
download_urlstring required
expires_atstring required
email_sentboolean required

Changes

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