VOvoucherifyio
Customers

Delete Customer Permanently

The organization user can remove consumer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify.

post/v1/customers/{customerId}/permanent-deletion

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/customers/{customerId}/permanent-deletion
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, customers

Response

Returns a permanent deletion object and status of the deletion.

idstring required

Unique permanent deletion object ID.

created_atstring date-time required

Timestamp representing the date and time when the customer was requested to be deleted in ISO 8601 format.

related_object_idstring required

Unique customer ID that is being deleted.

related_objectstring required

Object being deleted.

statusstring required

Deletion status.

objectstring required

The type of the object represented by JSON.

Example response

{
  "id": "del_mgzqZNwUnwnt1Ddw6phEG90Q",
  "created_at": "2022-09-02T17:55:47.865Z",
  "related_object_id": "cust_m557pDDl4IGXexkU6KOQ2Dwi"
}

Changes

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