younifyd
Menu

Customer Permanently Deletion

Delete Customer Permanently

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

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Customer Permanently Deletion action (under Customers).
  3. Fill in the fields below, then reference the result from later steps as {{customerPermanentlyDeletion.response.data}}.

Request

Path parameters

customerIdstringrequired

A Voucherify customer's `id` or `source_id`.

Response

Returns 200 with an object. Read it in later steps with {{customerPermanentlyDeletion.response.data.<field>}}.

idstring

Unique permanent deletion object ID.

created_atstring (date-time)

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

related_object_idstring

Unique customer ID that is being deleted.

related_objectstring

Object being deleted.

Default "customer"

statusstring

Deletion status.

Default "DONE"

data_jsonobject

Statistics summarizing the number of related information that was deleted.

eventsinteger

Number of events deleted.

customer_eventsinteger

Number of customer events deleted.

daily_eventsinteger

Number of daily events deleted.

segmentsinteger

Number of segments deleted.

ordersinteger

Number of orders deleted.

order_eventsinteger

Number of order events deleted.

customerinteger

Number of customers deleted.

Default 1

objectstring

The type of the object represented by JSON.

Default "pernament_deletion"

json
{
  "id": "del_mgzqZNwUnwnt1Ddw6phEG90Q",
  "created_at": "2022-09-02T17:55:47.865Z",
  "related_object_id": "cust_m557pDDl4IGXexkU6KOQ2Dwi",
  "related_object": "customer",
  "status": "DONE",
  "data_json": {
    "events": 0,
    "customer_events": 0,
    "daily_events": 0,
    "segments": 0,
    "orders": 0,
    "order_events": 0,
    "customer": 1
  },
  "object": "pernament_deletion"
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.