Aller au contenu
adaptmailAPI
Français

Paramètres de la boîte aux lettres

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

Utilisez /v1 pour modifier name, password et signature. Modifiez le quota commun quota_mb dans le panneau de votre hébergeur. Les fichiers n’ont pas de quota séparé. Idempotency-Key est facultatif, mais recommandé pour les nouvelles tentatives.

Zones d’autorisation et d’accès · Erreurs et répétitions

Demande

Fenêtre de terminal
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"}'

Possibilités

mailbox_idpathNécessairement

integer

X-Customer-IDheader
Option 1

string

Option 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

Corps de la demande · 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

Les champs inconnus ne sont pas acceptés.

Réponses

202 Réponse réussie

application/json

object

id

string · uuid

ID d'opération pour vérifier le statut et annuler une soumission en attente.

kind

string

mailbox_id
Option 1

integer

Option 2

null

status

string

Valeurs valides: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

created_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

completed_at
Option 1

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

Option 2

null

error

La raison de l'erreur si l'opération n'a pas abouti.

Option 1

string

Option 2

null

result

Le résultat de l'opération. Pour l'envoi, contient des informations sur les destinataires acceptés et rejetés.

Option 1

object

Option 2

null

400 En-tête ou identifiant invalide

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

401 Connexion requise

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

403 Pas d'accès

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

404 Ressource introuvable

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

409 Conflit d'État

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

422 Erreur de validation

application/json

object

detail

array

Éléments du tableau

object

locNécessairement

array

Éléments du tableau
Option 1

string

Option 2

integer

msgNécessairement

string

typeNécessairement

string

503 Indisponibilité temporaire

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object