Topolo Docs Topolo Platform
Open workspace

Choose sender profile

Choose the Nexus email profile (an id from app_topolo_nexus.email.profiles.list) that this workspace sends as, or null to stop sending through Nexus (sends are then recorded only). A new profile starts unverified and nothing is emailed until sending_settings.verify passes.

Outcome

Choose the Nexus email profile (an id from app_topolo_nexus.email.profiles.list) that this workspace sends as, or null to stop sending through Nexus (sends are then recorded only). A new profile starts unverified and nothing is emailed until sending_settings.verify passes.

Before you start

  • Verify identity and pin the intended organization and environment before discovering the action.
  • Discover a granted Nurture workspace. The application permission is workspace:write; required workspace access is admin. A permission alone does not supply a workspace grant.
  • Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
  • Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.sending_settings.update --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions --service topolo-nexus --query profiles --detail --json
  • profileId: Granted Nexus sending profile id. Discover the available Nexus profile actions before configuring it.

Request

PUT /api/sending-settings

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

FieldRequiredTypeConstraints
profileIdRequiredSee schemaGranted Nexus sending profile id. Discover the available Nexus profile actions before configuring it. {}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "profileId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "profileId"
  ],
  "additionalProperties": false
}

Effects

  • Stores the profile id with verificationStatus unverified, or removes the settings when profileId is null.

Interpret the response

Settings can contain no configured sending profile. Use a nonempty profile id only after inspecting configuration; verify queued counts separately.

Call app_topolo_nurture.sending_settings.get and confirm profileId.

Exact success schema:

{
  "type": "object",
  "required": [
    "sending"
  ],
  "properties": {
    "sending": {
      "type": "object",
      "required": [
        "configured",
        "profileId",
        "verificationStatus",
        "problems",
        "queued",
        "backgroundSending"
      ],
      "properties": {
        "configured": {
          "type": "boolean"
        },
        "profileId": {
          "type": [
            "string",
            "null"
          ]
        },
        "verificationStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "unverified",
            "verified",
            "failed",
            null
          ]
        },
        "problems": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "profile_not_found",
              "profile_inactive",
              "feedback_provider_required",
              "domain_unverified",
              "marketing_subdomain_required"
            ]
          }
        },
        "sender": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "fromEmail": {
              "type": [
                "string",
                "null"
              ]
            },
            "fromName": {
              "type": [
                "string",
                "null"
              ]
            },
            "provider": {
              "type": [
                "string",
                "null"
              ]
            },
            "sendingDomain": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "verifiedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "updatedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "queued": {
          "type": "object",
          "additionalProperties": {
            "type": "integer"
          }
        },
        "backgroundSending": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "detail": {
              "type": "string"
            }
          }
        },
        "deliveryEvents": {
          "type": "object",
          "required": [
            "mode",
            "connected",
            "missing"
          ],
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "events",
                "polling"
              ]
            },
            "connected": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "missing": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "checkedWith": {
      "type": "string"
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "profileId": "prf_news"
}

CLI:

topolo actions validate app_topolo_nurture.sending_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.sending_settings.update",
    "input": {
      "profileId": "prf_news"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "sending": {
    "configured": true,
    "profileId": "prf_news",
    "verificationStatus": "unverified",
    "problems": [],
    "sender": null,
    "verifiedAt": null,
    "updatedAt": "2026-10-01T09:00:00.000Z",
    "updatedBy": "u1",
    "queued": {},
    "backgroundSending": {
      "available": false,
      "detail": "No published app service credential for Nexus (Auth item item_1790858079922_tuvijcbi0): background sends stay queued."
    },
    "deliveryEvents": {
      "mode": "polling",
      "connected": [],
      "missing": [
        "nexus.email.delivered",
        "nexus.email.bounced.hard",
        "nexus.email.bounced.soft",
        "nexus.email.complained",
        "nexus.email.replied",
        "nexus.email.auto_reply",
        "nexus.email.unsubscribed"
      ]
    }
  }
}

HTTP 200. Call app_topolo_nurture.sending_settings.get and confirm profileId.

Another supported request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "profileId": "prf_unknown"
}

CLI:

topolo actions validate app_topolo_nurture.sending_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.sending_settings.update",
    "input": {
      "profileId": "prf_unknown"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "sending": {
    "configured": true,
    "profileId": "prf_unknown",
    "verificationStatus": "unverified",
    "problems": [],
    "sender": null,
    "verifiedAt": null,
    "updatedAt": "2026-10-01T09:00:00.000Z",
    "updatedBy": "u1",
    "queued": {},
    "backgroundSending": {
      "available": false,
      "detail": "No published app service credential for Nexus (Auth item item_1790858079922_tuvijcbi0): background sends stay queued."
    },
    "deliveryEvents": {
      "mode": "polling",
      "connected": [],
      "missing": [
        "nexus.email.delivered",
        "nexus.email.bounced.hard",
        "nexus.email.bounced.soft",
        "nexus.email.complained",
        "nexus.email.replied",
        "nexus.email.auto_reply",
        "nexus.email.unsubscribed"
      ]
    }
  }
}

HTTP 200. Call app_topolo_nurture.sending_settings.get and confirm profileId.

Refused request · permission_denied

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "profileId": "prf_news"
}

CLI:

topolo actions validate app_topolo_nurture.sending_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:write.",
    "details": {
      "requiredPermission": "workspace:write"
    }
  }
}

HTTP 403. Preserve the refusal details and do not claim success.

Refused request · invalid_input

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "profileId": ""
}

CLI:

topolo actions validate app_topolo_nurture.sending_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.sending_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "origin": "string",
        "code": "too_small",
        "minimum": 1,
        "inclusive": true,
        "path": [
          "profileId"
        ],
        "message": "Too small: expected string to have >=1 characters"
      }
    ]
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Verify the result

  • Call app_topolo_nurture.sending_settings.get and confirm profileId.

Errors and recovery

  • organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
  • permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
  • workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
  • invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

Read the settings first, then set the previous profileId (or null) again and verify it.

  • Verify sender profile: Check the chosen profile through app_topolo_nexus.email.profiles.list, as the caller: it must exist, be active, use a provider that reports bounces and complaints (resend or ses), be on a domain Nexus verified, and send from a subdomain (e.g. news.example.com) so marketing reputation stays off the root domain. Saves verified or failed with the problems.
  • Choose sender profile: Choose the Nexus email profile (an id from app_topolo_nexus.email.profiles.list) that this workspace sends as, or null to stop sending through Nexus (sends are then recorded only). A new profile starts unverified and nothing is emailed until sending_settings.verify passes.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.