9 Customers API: How to delete a handle

This is a series of articles dedicated to managing customer objects via Openprovider API.

This is a fourth article in a series in which we are going to cover customer handle deletion. To get more information about our API in general, please use our documentation portal as your reference.

Deleting a handle

This article shows how to delete a customer. Handle deletion removes an existing customer object and all its records. 

NB The operation will only succeed if no domains (or other objects) are linked to this customer handle.

The name of the handle is the only parameter that is required to perform this operation.

Entering Geo Fence iconUse endpoint path below. Base URL is determined by both the target environment and API version.
DEL {base_url}/customers/{handle}

REQUEST VALUES

Name Type Description
handle string Required.

REQUEST EXAMPLE

curl -X DELETE \
'https://api.openprovider.euv1beta/customers/TP123456-NL' \
-H 'Authorization: ,Bearer 811eac2d-******-06aa469aeb61' \

RESPONSE EXAMPLE

{
"code": 0,
"data": {
"success": true
},
"desc": ""
}
Depending on the outcome, one will either receive code 0 (in case of success) or an error code with an error message.
Was this article helpful?
0 out of 0 found this helpful
Additional questions? Submit a request