Skip to main content
POST
Capture a Lead
Send the donor details, the emailLists to subscribe them to, and any customFields or customCollections the page collected. The lead doesn’t need a page. To attribute it, send a segmentCode, a motivationCodeId, or a motivationCodeGroupId. To attach a free premium, send its premiumId, optionally with a premiumVariantId, or send a premiumOverrideCode. Raise resolves all of these within your organization.
Send isTestMode=true to try the call without recording a live donor.
Errors arrive in the ProblemDetails envelope. A 400 names the field at fault: a missing donor, a motivationCodeId, motivationCodeGroupId or segmentCode that doesn’t resolve, or a premiumId that isn’t active, free, or in stock, or whose premiumVariantId isn’t one of its variants. A premiumOverrideCode that matches no free premium is ignored. An unexpected failure returns 500 with a traceId to include when you contact support.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The lead to record, including the donor details and the emailLists, customFields, and customCollections the page collected.

isTestMode
boolean

When true, validates the call without recording a live donor.

donor
object | null

The donor who submitted the page.

emailLists
string[] | null

The names of the email lists to subscribe the donor to.

customFields
object[] | null

The custom field responses collected on the page.

customCollections
object[] | null

The custom collection responses collected on the page.

Response

OK