Update an inbox

Rename an inbox. The generated address does not change.

patch

Authorizations

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

inbox_idintegerRequired

Inbound inbox ID

Example: 1

Body

namestring · max: 100RequiredExample: Support tickets

Responses

200

Inbox updated

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support tickets

addressstringOptional

The inbox's inbound address. For a standard Mailtrap-hosted inbox this is a unique generated address. For a custom-domain inbox it is the catch-all form *@your-domain.com, which receives mail sent to any address on that domain.

Example: [e-mail]

domain_idintegerOptional

ID of the sending domain the inbox is attached to. For a custom-domain inbox this is your own sending domain; for a standard hosted inbox it is the Mailtrap-managed domain backing the inbox.

Example: 892

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Validation error

application/json

patch/api/inbound/folders/{folder_id}/inboxes/{inbox_id}

curl -X PATCH https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes/{inbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Support tickets v2" }'

{
  "id": 1,
  "name": "Support tickets",
  "address": "[e-mail]",
  "domain_id": 892
}