Mailboxes

Pause a mailbox

Stops the mailbox sending and stops new inbound mail reaching it. Mail that arrives while it is paused is not added when it resumes. Resume it with POST /v1/mailboxes/{id}/resume.

post/v1/mailboxes/{id}/pause

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}/pause
  • Auth: API key in header x-api-key

Path parameters

idstring required

Response

Mailbox

idstring required
namespaceIdstring required
slugstring required
namestring required
status'active' | 'paused' required
primaryAddressstring nullable required
createdAtstring required
descriptionstring nullable required
metadataMailboxMetadata required
updatedAtstring required

Changes

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