Actualizar las preferencias de envío

PATCH /api/v1/settings/sending La dirección postal y el remitente por defecto. Requiere el rol Admin. Semántica PATCH estricta: un campo que omites no se toca, un campo en null se borra y vuelve al valor alternativo. Nunca vuelvas a enviar el objeto completo para cambiar un solo campo.

Autorización

Rol en la organización	Este endpoint
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Rechazado — `403`

Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
`postalAddress`	string	no	Dirección física impresa en el pie. `null` la borra
`senderEmail`	string	no	Promueve o crea la dirección de remitente por defecto; se rechaza salvo que su dominio esté verificado y probado
`senderName`	string	no	Nombre visible de esa dirección

Ejemplo

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"

Respuesta

200 OK: la llamada tuvo éxito.
400 Bad Request: la validación falló; details lleva los problemas campo por campo.
401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
403 Forbidden: el propietario de la clave es member de la organización, no admin.
429 Too Many Requests: más de 120 peticiones en un minuto para esta clave.

Campos de la respuesta

Campo	Tipo	Descripción
`success`	boolean	Indica si la operación tuvo éxito
`data.senderEmail`	string \	null
`data.senderName`	string \	null
`data.postalAddress`	string \	null
`data.effectiveSender`	string \	null

Ejemplo de respuesta

json

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