Skip to documentation

API · API keys

Delete API key

Delete an API key (requires full access).

DELETE/api-keys/{id}Full access

Request parameters

ParameterTypeDescription
id
path · required
stringOpaque resource id.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X DELETE "$OPENSEND_BASE_URL/api-keys/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "object": "api_key",
  "id": "YOUR_ID",
  "deleted": true
}

Behavior and errors

Subsequent REST and SMTP operations using the token are refused, including submissions over an existing authenticated SMTP connection.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.