Beneficiaries

Update a beneficiary

Updates a saved beneficiary. type, name, and method are required on every update, even when their values have not changed — an update that omits method is rejected rather than treated as a partial edit.

put/v2/parties/{id}

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/parties/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

The beneficiary's _id.

Request body

type'beneficiary' required

Must be beneficiary.

namestring required

The beneficiary's name.

phoneNumberstring

The beneficiary's phone number. Optional.

countryCodestring

Required when phoneNumber is set, for example +20.

emailAddressstring

The beneficiary's email address. Optional.

labelsstring[]

Label strings used to organize beneficiaries. Optional.

preferredCommunicationChannel'sms' | 'email' | 'both'
presetNamestring

Saves the customFields keys as a reusable preset under this name. Optional.

Response

The updated beneficiary. This route nests its payload one level deeper than the others — the record is at body.body, and body.message carries the update confirmation.

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.