Modifier les préférences d'envoi

PATCH /api/v1/settings/sending L'adresse postale et l'expéditeur par défaut. Rôle admin requis. Sémantique PATCH stricte : un champ que vous omettez n'est pas touché, un champ à null est effacé et revient à la valeur de repli. Ne renvoyez jamais l'objet entier pour changer un seul champ.

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Refusé — `403`

Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

Champ	Type	Obligatoire	Description
`postalAddress`	string	non	Adresse physique imprimée dans le pied de page. `null` l'efface
`senderEmail`	string	non	Promeut ou crée l'adresse d'expéditeur par défaut — refusé si son domaine n'est pas vérifié et prouvé
`senderName`	string	non	Nom affiché de cette adresse

Exemple

bash

curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"postalAddress": "12 rue des Lilas, 59000 Lille"}' \
  "https://www.agentsmail.io/api/v1/settings/sending"

Réponse

200 OK — l'appel a réussi.
400 Bad Request — la validation a échoué ; details porte les erreurs champ par champ.
401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data.senderEmail`	string \	null
`data.senderName`	string \	null
`data.postalAddress`	string \	null
`data.effectiveSender`	string \	null

Exemple de réponse

json

{
  "success": true,
  "data": {
    "senderEmail": "hello@mail.example.com",
    "senderName": "Example",
    "postalAddress": "12 rue des Lilas, 59000 Lille",
    "effectiveSender": "Example <hello@mail.example.com>"
  }
}