Zum Inhalt springen
adaptmailAPI
Deutsch

Postfacheinstellungen

API 0.16.0OpenAPIllms-full.txt
PATCH/v1/mailboxes/{mailbox_id}

Über /v1 können Sie name, password und signature ändern. Die gemeinsame quota_mb wird im Hosting-Panel geändert. Für Dateien gibt es keine separate Quote. Idempotency-Key ist optional, wird aber für Wiederholungen empfohlen.

Berechtigungs- und Zugangsbereiche · Fehler und Wiederholungen

Anfrage

Terminal-Fenster
curl -X PATCH 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Support","signature":"Support team"}'

Optionen

mailbox_idpathUnbedingt

integer

X-Customer-IDheader
Option 1

string

Option 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

Anforderungstext · application/json

object

name
Option 1

string

minLength: 1

maxLength: 120

Option 2

null

quota_mb
Option 1

integer

minimum: 10240

Option 2

null

file_quota_mb
Option 1

integer

minimum: 256

maximum: 512000

Option 2

null

password
Option 1

string

minLength: 12

maxLength: 128

Option 2

null

signature
Option 1

string

maxLength: 5000

Option 2

null

Unbekannte Felder werden nicht akzeptiert.

Antworten

202 Erfolgreiche Antwort

application/json

object

id

string · uuid

Vorgangs-ID zum Überprüfen des Status und Abbrechen einer ausstehenden Übermittlung.

kind

string

mailbox_id
Option 1

integer

Option 2

null

status

string

Gültige Werte: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

created_at

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

completed_at
Option 1

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

Option 2

null

error

Der Grund für den Fehler, wenn der Vorgang nicht erfolgreich abgeschlossen wurde.

Option 1

string

Option 2

null

result

Das Ergebnis der Operation. Enthält zum Versenden Informationen über angenommene und abgelehnte Empfänger.

Option 1

object

Option 2

null

400 Ungültiger Header oder Bezeichner

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

401 Anmeldung erforderlich

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

403 Kein Zugriff

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

404 Ressource nicht gefunden

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

409 Staatskonflikt

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

422 Validierungsfehler

application/json

object

detail

array

Array-Elemente

object

locUnbedingt

array

Array-Elemente
Option 1

string

Option 2

integer

msgUnbedingt

string

typeUnbedingt

string

503 Vorübergehende Nichtverfügbarkeit

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object