---
title: Toast API
description: The API for interacting with toast.
api_version: 2026-07
api_name: customer-account-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2026-07-rc/target-apis/platform-apis/toast-api
  md: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2026-07-rc/target-apis/platform-apis/toast-api.md
---

# Toast API

The API for interacting with toast.

### Support Targets (24)

### Supported targets

* customer-account.​footer.​render-after
* customer-account.​order-index.​announcement.​render
* customer-account.​order-index.​block.​render
* customer-account.​order-status.​announcement.​render
* customer-account.​order-status.​block.​render
* customer-account.​order-status.​cart-line-item.​render-after
* customer-account.​order-status.​cart-line-list.​render-after
* customer-account.​order-status.​customer-information.​render-after
* customer-account.​order-status.​fulfillment-details.​render-after
* customer-account.​order-status.​payment-details.​render-after
* customer-account.​order-status.​return-details.​render-after
* customer-account.​order-status.​unfulfilled-items.​render-after
* customer-account.​order.​action.​menu-item.​render
* customer-account.​order.​action.​render
* customer-account.​order.​page.​render
* customer-account.​page.​render
* customer-account.​profile.​addresses.​render-after
* customer-account.​profile.​announcement.​render
* customer-account.​profile.​block.​render
* customer-account.​profile.​company-details.​render-after
* customer-account.​profile.​company-location-addresses.​render-after
* customer-account.​profile.​company-location-payment.​render-after
* customer-account.​profile.​company-location-staff.​render-after
* customer-account.​profile.​payment.​render-after

## StandardApi

The base API object provided to this and other `customer-account` extension targets.

* **toast**

  **ToastApi**

  **required**

  The Toast API displays a non-disruptive message that displays at the bottom of the interface to provide quick, at-a-glance feedback on the outcome of an action.

  How to use:

  * Use toasts to confirm successful actions.

  * Aim for two words.

  * Use noun + past tense verb format. For example, \`Changes saved\`.

  For errors, or information that needs to persist on the page, use a [banner](https://shopify.dev/docs/api/checkout-ui-extensions/web-components/feedback/banner) component.

### ToastApi

* show

  ```ts
  (content: string) => Promise<ToastApiResult>
  ```

### ToastApiResult

* hide

  ```ts
  () => void
  ```