Skip to content
Documentation/API reference
API · inboxes

Remove receiving address

DELETE /api/v2/inboxes/{id}/receiving-address

Authorization

Owner/admin user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

NameTypeContract
idpath · requiredResource UUID

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example
inboxit inboxes remove-address --id RESOURCE_UUID

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "id": "INBOX_UUID",
  "address": null,
  "status": "none"
}

Behavior & errors

Removes the custom route through durable cleanup. Does not delete the inbox or its stored messages. Reconcile pending routing after a temporary failure. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.