---
title: "Update existing beneficiary"
method: PATCH
path: "/v1/beneficiaries/{beneficiary_id}"
---

# Update existing beneficiary

`PATCH /v1/beneficiaries/{beneficiary_id}`

we only accept to update nickname, remark and is_favourite fields

## Path parameters

- `beneficiary_id` string, uuid, required

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `nickname` string
  - `remark` string
  - `is_favourite` true | false — Set to true to mark this beneficiary as favourite

## Response `200`

200

- object
  - `id` string, required
  - `status` string, required
  - `country` string, required
  - `currency` string, required
  - `transfer_method` string, required
  - `transfer_type` string, required
  - `nickname` string, required
  - `remark` string, required
  - `holder_name` string, required
  - `holder_type` string, required
  - `bank_branch_code` string, required
  - `account_number` string, required
  - `bank_name` string, required
  - `bank_id` string, required
  - `email` string, required
  - `bank_swift_code` string, required
  - `is_favourite` boolean, required
  - `created_by` object, required
    - `id` string, required
    - `display_name` string, required
    - `first_name` string, required
    - `last_name` string, required
  - `created_at` string, required
  - `updated_at` string, required
  - `deleted_at` string, nullable, required

## Other responses

- `422` — 422

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)