Skip to content

delete_whats_app_message_template

delete_whats_app_message_template(
    id: LinkedWhatsAppBusinessAccountId,
    template_name: MetaTemplateName,
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    meta_template_id: Optional[MetaTemplateId] = None,
    delete_all_languages: Optional[DeleteAllLanguages] = None,
) -> DeleteWhatsAppMessageTemplateOutput

Deletes a WhatsApp message template.

Parameters:

Raises:

Source code in docs_src/capo_socialmessaging/_services/social_messaging.py
def delete_whats_app_message_template(
    self,
    id: "capo_socialmessaging.types.linked_whats_app_business_account_id.LinkedWhatsAppBusinessAccountId",
    template_name: "capo_socialmessaging.types.meta_template_name.MetaTemplateName",
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    meta_template_id: Optional[
        "capo_socialmessaging.types.meta_template_id.MetaTemplateId"
    ] = None,
    delete_all_languages: Optional[
        "capo_socialmessaging.types.delete_all_languages.DeleteAllLanguages"
    ] = None,
) -> "capo_socialmessaging.types.delete_whats_app_message_template_output.DeleteWhatsAppMessageTemplateOutput":
    """<p>Deletes a WhatsApp message template.</p>

    Args:
        meta_template_id: <p>The numeric ID of the template assigned by Meta.</p>
        delete_all_languages: <p>If true, deletes all language versions of the template.</p>
        id: <p>The ID of the WhatsApp Business Account associated with this template.</p>
        template_name: <p>The name of the template to delete.</p>

    Raises:
        capo_socialmessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value. </p>
        capo_socialmessaging.errors.access_denied_by_meta_exception.AccessDeniedByMetaException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.dependency_exception.DependencyException: <p>Thrown when performing an action because a dependency would be broken.</p>
        capo_socialmessaging.errors.internal_service_exception.InternalServiceException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_socialmessaging.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the action are not valid.</p>
        capo_socialmessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_socialmessaging.errors.throttled_request_exception.ThrottledRequestException: <p>The request was denied due to request throttling.</p>
        capo_socialmessaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_socialmessaging.types.delete_whats_app_message_template_input.DeleteWhatsAppMessageTemplateInput]",
    ) -> OperationResponse[
        "capo_socialmessaging.types.delete_whats_app_message_template_output.DeleteWhatsAppMessageTemplateOutput"
    ]:
        import capo_socialmessaging._operations.social_messaging.delete_whats_app_message_template

        output, http_response = (
            capo_socialmessaging._operations.social_messaging.delete_whats_app_message_template.delete_whats_app_message_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWhatsAppMessageTemplate")
    )
    input_: capo_socialmessaging.types.delete_whats_app_message_template_input.DeleteWhatsAppMessageTemplateInput = {
        "id": id,
        "template_name": template_name,
    }
    if meta_template_id is not None:
        input_["meta_template_id"] = meta_template_id
    if delete_all_languages is not None:
        input_["delete_all_languages"] = delete_all_languages

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output