Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Mailbox

Update Mailbox status

Enable or disable a Mailbox

patch/mailbox/address/{id}/status

Path parameters

idstring required

Request body

status'enabled' | 'disabled' required

Mailbox status, either 'enabled' or 'disabled'

Response

Mailbox updated

idstring
email_addressstring

Email address to be used in Mailbox steps

context_idstring

Context ID for which email address is being generated

created_timeinteger

Time Mailbox was created

created_by_idstring

ID of user who created Mailbox

last_updated_timeinteger

Time Mailbox was last updated

last_updated_by_idstring

ID of user who last updated Mailbox

workspace_idstring
namestring

Email address name (permanent emails only)

descriptionstring

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_timeinteger

Time Mailbox was disabled. If null, the Mailbox is enabled.