Delete Targeted List Build

print_mail.targeted_list_builds.delete() -> TargetedListBuildDeleteResponse

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.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class TargetedListBuildDeleteResponse: …

id: str

A unique ID prefixed with targeted_list_build_

deleted: Literal[true]

Delete Targeted List Build

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
targeted_list_build = client.print_mail.targeted_list_builds.delete(
    "id",
)
print(targeted_list_build.id)

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

Returns Examples

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