> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Update Catalog Image

> Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object.

`square.updateCatalogImage` uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object.

## Example

```ts automations/square-update-catalog-image.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Update Square Catalog Image", () => {
  onDashboardRun({ title: "Update Square Catalog Image" })

  square.updateCatalogImage({
    imageId: "image_id",
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `ITEMS_WRITE`.

| Field       | Type                                         | Required | Default | Description                                                                |
| ----------- | -------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `imageId`   | `string`                                     | Yes      | —       | The ID of the `CatalogImage` object to update the encapsulated image file. |
| `request`   | `Square.UpdateCatalogImageRequest`           | No       | —       | Square `request` request field.                                            |
| `imageFile` | `File \| fs.ReadStream \| Blob \| undefined` | No       | —       | Square `imageFile` request field.                                          |

Use the official [UpdateCatalogImage reference](https://developer.squareup.com/reference/square/catalog-api/update-catalog-image) for provider field semantics and limits.

## Output

Returns the official `Square.UpdateCatalogImageResponse` response as a codec-safe object. Square integer money amounts remain `bigint` values.