Campaigns

Delete Campaign

Changed on

Delete a campaign.

Campaigns can only be deleted if they are in draft, changes_required, or ready status. This also permanently deletes associated resources. This operation cannot be undone.

delete/print-mail/v1/campaigns/{id}

Request

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

Path parameters

idstring required

The unique identifier (campaign_...) for the campaign to delete.

Response

A confirmation object indicating the campaign was marked for deletion.

idstring required

A unique ID prefixed with campaign_

deletedtrue required

Changes

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status