---
title: "Update Mailbox"
method: PATCH
path: "/mailbox/address/{id}"
tags: ["Mailbox"]
---

# Update Mailbox

`PATCH /mailbox/address/{id}`

Update the name and description of a permanent Mailbox. The email address cannot be changed.

## Path parameters

- `id` string, required

## Request body

- Mailbox
  - `id` string
  - `email_address` string — Email address to be used in Mailbox steps
  - `context_id` string — Context ID for which email address is being generated
  - `created_time` integer — Time Mailbox was created
  - `created_by_id` string — ID of user who created Mailbox
  - `last_updated_time` integer — Time Mailbox was last updated
  - `last_updated_by_id` string — ID of user who last updated Mailbox
  - `workspace_id` string
  - `name` string — Email address name (permanent emails only)
  - `description` string — Email address description (permanent emails only)
  - `lifespan` 'permanent' | 'variable' — Defines how long email address will be accessible. Permanent Mailboxes are always accessible. Variable Mailboxes are accessible only during a single context (test run / training session). Note that accessibility here refers to the email address itself, not the contents of the Mailbox. When undefined, defaults to variable.
  - `disabled_time` integer — Time Mailbox was disabled. If null, the Mailbox is enabled.

## Response `200`

Mailbox updated

- Mailbox
  - `id` string
  - `email_address` string — Email address to be used in Mailbox steps
  - `context_id` string — Context ID for which email address is being generated
  - `created_time` integer — Time Mailbox was created
  - `created_by_id` string — ID of user who created Mailbox
  - `last_updated_time` integer — Time Mailbox was last updated
  - `last_updated_by_id` string — ID of user who last updated Mailbox
  - `workspace_id` string
  - `name` string — Email address name (permanent emails only)
  - `description` string — Email address description (permanent emails only)
  - `lifespan` 'permanent' | 'variable' — Defines how long email address will be accessible. Permanent Mailboxes are always accessible. Variable Mailboxes are accessible only during a single context (test run / training session). Note that accessibility here refers to the email address itself, not the contents of the Mailbox. When undefined, defaults to variable.
  - `disabled_time` integer — Time Mailbox was disabled. If null, the Mailbox is enabled.

## Other responses

- `400` — Invalid or missing parameter
- `403` — User not authorized
- `404` — No Mailbox matching this ID could be found
- `default` — Unknown error

---

[API](https://skmtc.net/mabl/apis/mabl-api.md) · [All operations](https://skmtc.net/mabl/apis/mabl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mabl/mabl-api/revisions/d0fc0114da66/schema)