deleteEmailTemplate method

Future<DeleteEmailTemplateResponse> deleteEmailTemplate({
  1. required String templateName,
  2. String? version,
})

Deletes a message template for messages that were sent through the email channel.

May throw BadRequestException. May throw InternalServerErrorException. May throw PayloadTooLargeException. May throw ForbiddenException. May throw NotFoundException. May throw MethodNotAllowedException. May throw TooManyRequestsException.

Parameter templateName : The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Parameter version : The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.
  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
  • For a delete operation, deletes the template, including all versions of the template.

Implementation

Future<DeleteEmailTemplateResponse> deleteEmailTemplate({
  required String templateName,
  String? version,
}) async {
  ArgumentError.checkNotNull(templateName, 'templateName');
  final $query = <String, List<String>>{
    if (version != null) 'version': [version],
  };
  final response = await _protocol.sendRaw(
    payload: null,
    method: 'DELETE',
    requestUri: '/v1/templates/${Uri.encodeComponent(templateName)}/email',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  final $json = await _s.jsonFromResponse(response);
  return DeleteEmailTemplateResponse(
    messageBody: MessageBody.fromJson($json),
  );
}