update_payment_recipient
Rename or archive a saved recipient (free)
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| archived | No | Must be a boolean. A wrong type returns a terminal 400 with code `invalid_archived`. | |
| platform | Yes | Payment platform the recipient is saved under. | |
| display_name | No | Must be a string. A wrong type returns a terminal 400 with code `invalid_display_name`. | |
| recipient_id | Yes | The entry's `recipient_id` from `GET /payment-recipients` (an opaque id, not the phone number or email). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | ||
| archived | No | ||
| platform | No | ||
| display_name | No | ||
| recipient_id | No |