Update the mailbox holder's settings

PUT/api/v1/mailbox/settings

Requires amailbox token— it acts as one mailbox holder, not as the organization.

Partial update -- only the fields present are changed. The signature is sanitised against an allowlist before storage, because it is HTML this server later attaches to outgoing mail.

Request body

Request

PUT/api/v1/mailbox/settings

curl -X PUT 'https://app.mailyte.com/api/v1/mailbox/settings' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

const response = await fetch('https://app.mailyte.com/api/v1/mailbox/settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer MAILBOX_TOKEN',
  },
});
const { data } = await response.json();

import requests
response = requests.put(
    "https://app.mailyte.com/api/v1/mailbox/settings",
    headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('MAILBOX_TOKEN')
    ->put('https://app.mailyte.com/api/v1/mailbox/settings');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/mailbox/settings")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Successful Response

Returned inside the standard envelope.

Errors

Status	When
`422`	Validation Error

Every status, with what causes it and what to do, is on the error reference.