---
title: "Update payee"
method: PATCH
path: "/v0/payees/{payee-id}"
tags: ["Payees"]
---

# Update payee

`PATCH /v0/payees/{payee-id}`

Updates an existing payee.

You can update a payee with the outcome of a [CoP request](#tag/Confirmation-of-payee) by supplying a `cop-request-url`.

A payee can be deactivated by updating the `payee-status` of an active payee to `deactivated`. Any attempt to create or submit a payment to a deactivated payee will fail.

A 422 is served when attempting to deactivate an already-deactivated payee.

## Path parameters

- `payee-id` string, required

## Request body

- object
  - `cop-request-url` union — Link to a [CoP request](#tag/Confirmation-of-payee).
    - string
    - string
  - `payee-status` 'deactivated' — The status of the payee; you can only make payments to active payees.

## Response `200`

OK

- object
  - `cop-request-url` union — Link to a [CoP request](#tag/Confirmation-of-payee).
    - string
    - string
  - `payee-url` union, required — Link to the [payee](#tag/Payees).
    - string
    - string
  - `account-number` string, required — A UK account number.
  - `account-holder` string, required — The name of the [account holder](/docs/terms/account-holder).
  - `legal-person-url` union, required — A contextual link to the [legal person](#tag/Legal-persons).
    - string
    - string
  - `bank-id` string, required — A UK sort code.
  - `created-at` string, date-time, required — ISO 8601 formatted date-time.
  - `account-url` union — Link to the bank account resource.
    - string
    - string
  - `payee-status` 'deactivated' | 'active', required — The status of the payee; you can only make payments to active payees.
  - `country-code` string, required — ISO 3166-1 alpha-2 two-letter country code.

## Other responses

- `401` — Requires an API key to continue
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/griffin/apis/the-griffin-api.md) · [All operations](https://skmtc.net/griffin/apis/the-griffin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griffin/the-griffin-api/versions/178ed43d543b/schema)