commerce
commerce

Sell This List

Mint a payment link for the exact filtered list (admin-only).

Creates a hidden ad-hoc product (the sale's frozen filter + price), an order, and a Stripe Checkout Session — test-mode by default so the link is safe to click before going live. Returns the hosted checkout URL to send the buyer.

post/api/v1/commerce/sell

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

Request body

labelstring required
statestring nullable
filtersobject[]
entity_idsstring[] nullable
price_centsinteger required
lead_countinteger nullable
delivery_methodstring
audiencestring
crm_connection_idstring nullable
billingstring
buyer_emailstring nullable
test_modeboolean
success_urlstring nullable
cancel_urlstring nullable

Response

Successful Response

order_idstring required
product_idstring required
session_idstring required
checkout_urlstring required
matched_countinteger required
test_modeboolean required

Changes

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