Leer todos los ajustes

GET /api/v1/settings Todos los ajustes de la organización en una sola lectura: quién firma sus correos, cómo se comporta la suscripción y si puede enviar. Agregado a propósito: un agente que necesita seis llamadas para conocer el estado de una cuenta hará cinco y se equivocará.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/settings"

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 429 Too Many Requests: más de 120 peticiones en un minuto para esta clave.

Campos de la respuesta

effectiveSender es el que hay que comprobar, no senderEmail. Es la dirección con la que realmente saldrá la próxima campaña, incluida la alternativa que se usa mientras no hay ningún dominio verificado.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data.sending.senderEmailstring \null
data.sending.senderNamestring \null
data.sending.postalAddressstring \null
data.sending.effectiveSenderstring \null
data.optin.requiredbooleanSi un contacto nuevo debe confirmar antes de quedar suscrito
data.optin.subjectstringAsunto del correo de confirmación: el predeterminado si nunca se personalizó
data.optin.contentstringSu HTML, con la misma regla
data.optin.customizedbooleanfalse significa que los dos campos anteriores son los predeterminados del producto
data.readinessobjectEl mismo objeto que GET /api/v1/me devuelve bajo sending: ready, blockers, setup

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "sending": {
      "senderEmail": "hello@mail.example.com",
      "senderName": "Example",
      "postalAddress": "12 rue des Lilas, 59000 Lille",
      "effectiveSender": "Example <hello@mail.example.com>"
    },
    "optin": {"required": true, "subject": "Confirm your subscription", "content": "<html>…</html>", "customized": false},
    "readiness": {"ready": true, "blockers": [], "setup": {"status": "verified", "provisioning": "provisioned"}}
  }
}

Relacionado