Skip to main content
DELETE
/
integrations
/
vertofx
/
beneficiaries
/
{beneficiaryId}
/
unlink
Unlink Verto Beneficiary From User
curl --request DELETE \
  --url https://api.royalti.io/integrations/vertofx/beneficiaries/{beneficiaryId}/unlink \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Beneficiary unlinked successfully"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Description:
The /integrations/vertofx/beneficiaries/{beneficiaryId}/unlink endpoint unlinks a VertoFX beneficiary from a Royalti user. Method: DELETE Path Parameter:
ParameterTypeDescription
beneficiaryIdstringThe unique identifier of the beneficiary to unlink

​
Code Examples

const response = await fetch('https://api.royalti.io/integrations/vertofx/beneficiaries/example-id/unlink', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
beneficiaryId
string
required

Beneficiary ID to unlink

Response

Success

​
status
string
​
message
string