---
title: "Update payout metadata"
method: PATCH
path: "/payouts/{id}"
tags: ["Payouts"]
---

# Update payout metadata

`PATCH /payouts/{id}`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/payouts/{id}`
- Auth: API key in header `x-api-key`

Updates editable internal payout metadata such as reference and notes.

## Path parameters

- `id` string, required: Payout ID with orgpay_ prefix

## Request body

- object
  - `reference` string, nullable
  - `notes` string, nullable

## Response `200`

OK

- object
  - `id` string, required: Payout ID with orgpay_ prefix
  - `reference` string, nullable, required
  - `notes` string, nullable, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)