v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Targeted List Builds

Confirm Targeted List Build

Confirm a targeted list build whose quote is ready. This deducts the appropriate amount of list build credits from the organization (in live mode) and kicks off the asynchronous creation of the underlying mailing list.

post/print-mail/v1/targeted_list_builds/{id}/confirm

Path parameters

idstring required

The unique identifier (targeted_list_build_...) for the list build.

Response

The targeted list build after transitioning to creating_list.

idstring required

A unique ID prefixed with targeted_list_build_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

organizationstring required

The ID of the organization that owns this list build.

status'generating_quote' | 'quote_ready' | 'creating_list' | 'completed' | 'failed' required

Status of a targeted list build.

limitinteger

Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.

confirmedAtstring date-time

The UTC time at which the build was confirmed, if any.

completedAtstring date-time

The UTC time at which the build finished successfully. Only present once status is completed.

buildProgressPercentnumber float

A percentage from 0 to 100 representing how much of the build has completed. Only populated while status is creating_list.

mailingListstring

The ID of the mailing list that was built. Present once status is completed.