Skip to main content
POST
Rename or archive a saved recipient (free)

Authorizations

Authorization
string
header
required

Firebase ID token from /auth or any paid route, sent as a Bearer token: Authorization: Bearer <id_token> (the Bearer prefix is required).

Headers

Idempotency-Key
string

Optional client-generated unique key (a UUID works) that makes this write safe to retry. A retry with the same key within 24 hours returns the recorded response of the original request, marked with an Idempotency-Replayed: true header, instead of performing the write again. Reusing a key with a different body or route is rejected with 422 (code: idempotency_key_reused); a retry that arrives while the original is still running gets 409 (code: idempotency_key_in_progress), so wait a moment and retry with the same key. Keys are scoped to the authenticated account.

Maximum string length: 255

Body

application/json
platform
enum<string>
required

Payment platform the recipient is saved under.

Available options:
venmo,
paypal
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

The updated recipient.

user_id
string
platform
string
recipient_id
string
display_name
string
archived
boolean