API · inboxes

Assign receiving address

POST /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.

Name	Type	Contract
id	path · required	Resource UUID
address	string · required	Complete email, maximum 254 characters; local part maximum 64

Request

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

Example

inboxit inboxes address --id RESOURCE_UUID --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example

{
  "address": "hello@mail.yourbrand.com"
}

Response

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

Example

{
  "id": "INBOX_UUID",
  "address": "hello@mail.yourbrand.com",
  "status": "active"
}

Behavior & errors

Assigns or renames the receiving address on an active inbox. Domain must be verified in this workspace and MX must point exclusively to mail.inboxit.wtf. Routing 503 may mean a pending persisted change; inspect receiving_status. A conflicting pending change returns 409. 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.