Recipients

Edit information about a specific recipient

Changed on

Update an existing recipient's information

post/recipient/{recipientId}

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/recipient/{recipientId}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

recipientIdstring uuid required

The Mercury account where invoice payments will be deposited. Use the /api/v1/accounts endpoint to list your accounts and find the corresponding id. Only checking and savings accounts are supported.

Request body

contactEmailstring
emailsEmail[]
namestring
nicknamestring

Changes

  • ab652aa5aa8eRevision changes
    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed the optional property from the response with the status

    • info

      media type application/json was changed to application/json;charset=utf-8 for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

  • 57d0bcefe5d1Revision changes
    • info

      added the optional property to the response with the status