---
title: "Rename or archive a saved recipient (free)"
method: POST
path: "/payment-recipients"
---

# Rename or archive a saved recipient (free)

`POST /payment-recipients`

## Request

- Base URL: `https://laso.finance`
- URL: `https://laso.finance/payment-recipients`
- Auth: API key in header `Authorization`

Renames a saved Venmo or PayPal recipient, archives it, or both. Provide at least one of `display_name` or `archived`.

Archiving hides an entry from the default list while keeping its history, which is the reversible way to retire a recipient. Prefer it over `DELETE`.

Requires a Bearer token from `/auth` or `/get-card`.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `platform` 'venmo' | 'paypal', required: Payment platform the recipient is saved under.
  - `recipient_id` string, required: The entry's `recipient_id` from `GET /payment-recipients` (an opaque id, not the phone number or email).
  - `display_name` string: Must be a string. A wrong type returns a terminal 400 with code `invalid_display_name`.
  - `archived` boolean: Must be a boolean. A wrong type returns a terminal 400 with code `invalid_archived`.

## Response `200`

The updated recipient.

- object
  - `user_id` string
  - `platform` string
  - `recipient_id` string
  - `display_name` string
  - `archived` boolean

## Other responses

- `409`: A request with this `Idempotency-Key` is still being processed (`code: idempotency_key_in_progress`). Wait a moment and retry with the same key.
- `422`: The `Idempotency-Key` was already used for a different request body or route (`code: idempotency_key_reused`). Use a new key.

---

[API](https://skmtc.dev/laso/apis/laso-finance-x402-api.md) · [All operations](https://skmtc.dev/laso/apis/laso-finance-x402-api/llms.txt) · [OpenAPI document](https://skmtc.dev/laso/apis/laso-finance-x402-api/revisions/ff8ce20b49ba?raw)