Update Payee Email

Changes the email address of one of your payees.

Use it when a payee's email address changes, or to fix a typo before the payee onboards.

Requires the Administrator, Expert User or User role.

What happens:

  • The payee's email changes to email. If the payee's reference ID is its old email (you created it without a reference ID),
    the reference ID changes to the new email too.
  • If the payee has not finished onboarding and is not a payee of any other payor, the email they sign in with changes too.
    Otherwise they keep signing in with their current email.
  • Your payments to the payee show the new email and reference ID shortly after.
  • No invitation email is sent.
  • Sending the email the payee already has changes nothing and returns 204.

Errors

  • 400 EMAIL_ALREADY_IN_USE: another of your payees has this email.
  • 400 VALIDATION_ERROR: email is missing or invalid (INVALID_EMAIL when it is malformed or its domain does not accept
    email), or the body has another field.
  • 404 NOT_FOUND: you have no payee with this payeeId.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the payee: its userId from Search Payees or Create Payees.

Body Params
string
required

New email address of the payee. Payment Labs checks that it is well formed and that its domain accepts email.

Responses
204

The operation succeeded. The response has no body.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json