Mailboxes

Update a mailbox

Updates the fields you name and keeps the rest. metadata merges into the stored metadata by key, and a null value deletes that key. Change an endpoint's sender name or default with PATCH /v1/mailboxes/{id}/endpoints/{endpointId}.

patch/v1/mailboxes/{id}

Request

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

Path parameters

idstring required

Request body

namestring nullable
metadataMailboxMetadataPatch

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.