set_outbound_sender

Set the SMTP sender; smtp_password is write-only and never returned.

Input schema

{
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "from_address": {
      "title": "From Address",
      "type": "string"
    },
    "is_active": {
      "default": true,
      "title": "Is Active",
      "type": "boolean"
    },
    "smtp_host": {
      "title": "Smtp Host",
      "type": "string"
    },
    "smtp_password": {
      "title": "Smtp Password",
      "type": "string"
    },
    "smtp_port": {
      "title": "Smtp Port",
      "type": "integer"
    },
    "smtp_username": {
      "title": "Smtp Username",
      "type": "string"
    },
    "tls_mode": {
      "title": "Tls Mode",
      "type": "string"
    }
  },
  "required": [
    "application_id",
    "smtp_host",
    "smtp_port",
    "tls_mode",
    "smtp_username",
    "smtp_password",
    "from_address"
  ],
  "title": "set_outbound_senderArguments",
  "type": "object"
}

Output schema

{
  "description": "Metadata-only. Deliberately carries no credential ciphertext, key version, or\nmasked password — only presence plus non-secret fields (ADR §3).",
  "properties": {
    "configured": {
      "title": "Configured",
      "type": "boolean"
    },
    "from_address": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "From Address"
    },
    "is_active": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Active"
    },
    "smtp_host": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Smtp Host"
    },
    "smtp_port": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Smtp Port"
    },
    "smtp_username": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Smtp Username"
    },
    "tls_mode": {
      "anyOf": [
        {
          "enum": [
            "none",
            "starttls",
            "ssl"
          ],
          "title": "SmtpTlsMode",
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "configured"
  ],
  "title": "OutboundSenderStatusResponse",
  "type": "object"
}