InboxController

Update Inbox. Change name and description. Email address is not editable.

Update editable fields on an inbox

patch/inboxes/{inboxId}

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/inboxes/{inboxId}
  • Auth: API key in header x-api-key

Path parameters

inboxIdstring uuid required

Request body

namestring nullable

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

descriptionstring nullable

Description of an inbox for labelling and searching purposes

tagsstring[] nullable

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

expiresAtstring date-time nullable

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

favouriteboolean nullable

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.