Targeted List Builds

Update Targeted List Build

Changed on

Update an existing targeted list build. Only builds that have not yet been confirmed may be updated. Updating the filters or limit will reset the build's status back to generating_quote and a new quote will be generated.

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/targeted_list_builds/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

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

Request body

descriptionstring

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

metadataobject

See the section on Metadata.

limitinteger

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

Response

The updated targeted list build.

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.

Changes

  • 0e40d1471df0Revision changes
    • breaking

      the ///// response's property type changed from integer to number, and format from int32 to double for status

  • c8fedcbd705eRevision changes
    • info

      endpoint added