YAyapily
User Beneficiaries

Patch User Beneficiary

Patch the beneficiary details for a given application user and beneficiary

patch/users/{userId}/beneficiaries/{beneficiaryId}

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

beneficiaryIdstring uuid required

Beneficiary Id

Example:e7b7636d-a041-4013-8a1b-34dc85b7d341
userIdstring uuid required
Example:e7b7636d-a041-4013-8a1b-34dc85b7d341

Headers

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Request body

op'add' | 'replace' required

The operation to be performed

pathstring required

The path to the target location

valuestring required

The value to be added, replaced or tested

Response

OK

Example response

{
  "data": {
    "beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
    "details": {
      "name": "John Doe",
      "match": {
        "closeMatchName": "John Doe"
      },
      "accountIdentifier": {
        "identification": "DE12345123451234512345123"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.