Skip to main content
DELETE
/
recipients
/
{recipient_id}
Delete a recipient
curl --request DELETE \
  --url https://api.example.com/recipients/{recipient_id} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Recipient deleted"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access scope.

Path Parameters

recipient_id
string
required

The unique external ID of the recipient.

Response

Recipient deleted