Delete Webhook

print_mail.webhooks.delete() -> WebhookDeleteResponse

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

Delete a Webhook by ID. Note that this operation cannot be undone.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class WebhookDeleteResponse: …

id: str

A unique ID prefixed with webhook_

deleted: Literal[true]

object: Literal["webhook"]

Always webhook.

Delete Webhook

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
)
webhook = client.print_mail.webhooks.delete(
    "id",
)
print(webhook.id)

{
  "id": "webhook_skN2ZTvFwS62oc5tJY1gzw",
  "object": "webhook",
  "deleted": true
}

Returns Examples

{
  "id": "webhook_skN2ZTvFwS62oc5tJY1gzw",
  "object": "webhook",
  "deleted": true
}