Delete Address Set

DELETE

API for deleting an Address Set. A set with attached Webhooks (webhookCount of 1 or more) cannot be deleted; detach all Webhooks first. On success, result: true is returned.The delete request responds immediately and the stored addresses are cleaned up in the background. However, the set stops being retrievable (404) right after the response, so from the caller's perspective the operation is synchronous, and no separate deletion status appears in responses.

Path Parameters

addressSetIdstringrequired

Parameter that specifies the addressSetId assigned to the Address Set. Use the addressSetId returned when the Address Set was created. It is a 19-digit number but is returned as a string in JSON. Parsing it as a number in JavaScript or similar environments loses precision, so always handle it as a string.

Responses

resultboolean

Field indicating the result of the call. Returns true on success and false on failure.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}

X-API-KEY

cURL

curl -X DELETE 'https://web3.nodit.io/v1/webhook/address-sets/1788439512345678901' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{}'