user-xmarkDelete a Customer

Delete an existing customer profile using SenderWiz Admin API safely by first setting their status to 'Pending delete'.

๐Ÿ—‘๏ธ Delete a Customer

Remove a customer and all associated data permanently. This operation set the customer's status is set to Pending delete. Cleanup job removes data permanently in next scheduled run.

๐Ÿ”น HTTP Request

DELETE ADMIN-API-URL/customers/CUSTOMER-UID

๐Ÿ”ธ URL Segments

Segment
Type
Required
Description

CUSTOMER-UID

string

Yes

Unique identifier of the customer to update

๐Ÿ” Authorization Header

X-ADMIN-API-KEY: your-admin-api-key-here

โš ๏ธ Important Note

The delete operation changes the customer's status to Pending Delete, allowing the daily cleanup process to permanently remove the customer profile along with all associated data.

๐Ÿ’ป PHP Example

// DELETE CUSTOMER
$response = $endpoint->delete('ab382plq98zr7');

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

๐Ÿ“ฆ Sample JSON Response

Last updated