Delete Targeted List Build

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

Delete a targeted list build. List builds can only be deleted before they have been confirmed — once a build has transitioned to creating_list or completed it cannot be deleted.

Path ParametersExpand Collapse

id: string

ReturnsExpand Collapse

id: string

A unique ID prefixed with targeted_list_build_

deleted: true

Delete Targeted List Build

curl https://api.postgrid.com/print-mail/v1/targeted_list_builds/$ID \
    -X DELETE \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

{
  "id": "targeted_list_build_123",
  "deleted": true
}

Returns Examples

{
  "id": "targeted_list_build_123",
  "deleted": true
}