Email Templates

Delete an email template

Deletes an email template of the account. It asks for a confirmation and THERE IS NO WAY BACK: /v1/email-templates/create writes a new template with a new key, and every schedule that read the deleted one would have to be pointed at it.

It is refused with 409 IN_USE while any scheduled delivery is sent with the template, and details.used_by.schedules names them with their key, their report and their frequency. It is refused the same way, with details.reason client_portal, when it is the template the client portal sends its notifications with; which template that is, is chosen in the application.

The answer carries before with the whole template, body included, which is what it would take to write it again.

Every write endpoint reads dry_run and idempotency_key; see the Write guarantees section of the introduction.

post/email-templates/delete

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/email-templates/delete
  • Auth: HTTP bearer

Request body

email_template_keystring required

The template to delete. From /v1/email-templates/list.

dry_runboolean

Validate everything and write nothing.

idempotency_keystring

Replays the answer of an identical call for 24 hours.

confirmation_tokenstring

The token the first call answered with, to apply the operation.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.