Skip to main content
PATCH
/
v1
/
beneficiaries
Update Beneficiary Active Status
curl --request PATCH \
  --url https://sandbox.api.fin.com/v1/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiary_id": "f653e109-6c62-4aa4-869c-418c874e0a6c",
  "active": true
}
'
{
  "data": {
    "message": "Beneficiary updated successfully"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Obtain token from /v1/oauth/token endpoint

Body

application/json
​
beneficiary_id
string<uuid>
required

Unique identifier for the beneficiary

Example:

"f653e109-6c62-4aa4-869c-418c874e0a6c"

​
active
boolean
required

Set to true to activate or false to deactivate the beneficiary

Example:

true

Response

Beneficiary updated successfully

​
data
object