---
title: "Update a Deposit"
method: PATCH
path: "/v1/deposits/{depositId}/api-key"
tags: ["Deposits"]
---

# Update a Deposit

`PATCH /v1/deposits/{depositId}/api-key`

Updates an existing deposit by its ID. All fields in the request body are optional — only the provided fields will be updated. This can be used to change the deposit name, description, payment method options, disabled state, blockchain symbols, and more.

## Path parameters

- `depositId` string, required

## Query parameters

- `apiKey` string, required

## Request body

- UpdateDeposit — Request body for updating a deposit. All fields are optional.
  - `name` string — Name of the deposit.
  - `disabled` boolean — Whether the deposit is disabled.
  - `description` string — Description of the deposit.
  - `notifyReceiverByEmail` boolean — Send email notifications.
  - `connectWalletOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `transferManuallyOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `payWithCardOptions` DepositPaymentCardOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
    - `hasWhiteListDomain` boolean — Whether a whitelist domain is set.
  - `connectExchangeOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `disabledBlockchainSymbols` string[] — List of blockchain symbols for which deposits are disabled.
  - `minSweepAmountUsd` number — Minimum sweep amount in USD.

## Response `200`

Deposit updated successfully.

- DepositResponse — Response body for a deposit.
  - `id` string, required — Unique identifier of the deposit.
  - `name` string, required — Name of the deposit.
  - `description` string — Description of the deposit.
  - `paylinkId` string — Associated paylink identifier.
  - `platform` 'HELIO' | 'MAGIC_EDEN', required — Platform associated with the deposit.
  - `notifyReceiverByEmail` boolean, required — Whether the receiver is notified by email.
  - `disabled` boolean, required — Whether the deposit is disabled.
  - `disabledBlockchainSymbols` string[] — List of blockchain symbols for which deposits are disabled.
  - `connectWalletOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `transferManuallyOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `payWithCardOptions` DepositPaymentCardOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
    - `hasWhiteListDomain` boolean — Whether a whitelist domain is set.
  - `connectExchangeOptions` DepositPaymentOption — Configuration for a deposit payment option.
    - `isActive` boolean — Whether this option is shown/enabled.
    - `title` string — Display title for this option.
    - `badge` string — Optional badge label for this option.
    - `order` number — Display order for this option.
  - `minSweepAmountUsd` number — Minimum sweep amount in USD.
  - `createdAt` string, date-time, required — Timestamp when the deposit was created.
  - `updatedAt` string, date-time, required — Timestamp when the deposit was last updated.

## Other responses

- `401` — Provided API key has no access to the resource.

---

[API](https://skmtc.net/hel/apis/helio-open-api.md) · [All operations](https://skmtc.net/hel/apis/helio-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hel/helio-open-api/versions/5732beb2d39f/schema)