Mailboxes

Update a mailbox endpoint

Updates the fields you name and keeps the rest, and returns the mailbox. displayName is the name messages sent from the endpoint carry; null falls back to the mailbox's name. default: true makes the endpoint the one the mailbox starts new conversations from on its channel; replies always leave from the endpoint of their thread.

patch/v1/mailboxes/{id}/endpoints/{endpointId}

Request

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

Path parameters

idstring required
endpointIdstring required

Request body

displayNamestring nullable
defaulttrue nullable

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.