logo
Handle APIUnsubscribe a handle owned by the API key

Unsubscribe a handle owned by the API key

Performs a logical unsubscribe: sets the handle to inactive and clears its destination. The handle name remains permanently reserved.

curl -X POST "https://mail.haltman.io/api/handle/delete" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "handle": "example_string"
}'
{
  "ok": true,
  "updated": true,
  "handle": "example_string",
  "active": true
}
POST
/api/handle/delete
POST
API Key (header: X-API-Key)
X-API-Keystring
Required

64-character lowercase hexadecimal API key.

64-character lowercase hexadecimal API key.
Content-Typestring
Required

The media type of the request body

Options: application/json
handlestring
Required

The local-part to claim.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. 64-character lowercase hexadecimal API key.

Body

application/json
handlestring
Required

The local-part to claim.

Responses

okboolean
Required
updatedboolean
Required
handlestring
Required
activeboolean
Required
Allowed values:false