Replace configured sender addresses

PUT /api/v1/accounts/{accountId}/send-as

Replace the configured Outlook or IMAP aliases for an email account.

Authentication

Pass a Fluxmail member session or API key as a bearer token. API keys apply their mailbox scope and permissions to the request.

Request

curl 'http://localhost:8977/api/v1/accounts/acct_123/send-as' \
  -X PUT \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "identities": [
    {
      "email": "person@example.com"
    }
  ]
}'

Parameters

Name	Location	Required	Type	Details
`accountId`	path	Yes	`string`	Minimum length: 1.

Request body

Content type: application/json

{
  "type": "object",
  "properties": {
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "email"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "identities"
  ],
  "additionalProperties": false
}

Responses

Status	Description	Content type
`200`	Sender addresses replaced	`application/json`
`400`	Invalid request	`application/json`
`401`	Authentication required	`application/json`
`403`	Permission or plan denied	`application/json`
`404`	Resource not found	`application/json`
`409`	Request conflict	`application/json`
`422`	Unsupported capability	`application/json`
`429`	Provider rate limit	`application/json`
`500`	Internal error	`application/json`
`503`	Provider unavailable	`application/json`

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "name": {
            "type": "string"
          },
          "replyTo": {
            "type": "string",
            "format": "email"
          },
          "isPrimary": {
            "type": "boolean"
          },
          "source": {
            "type": "string",
            "enum": [
              "provider",
              "configured"
            ]
          }
        },
        "required": [
          "email",
          "isPrimary",
          "source"
        ],
        "additionalProperties": false
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}