Topolo Docs Topolo Platform
Open workspace

Set seat WhatsApp number

Set (or clear with null) the Nexus WhatsApp connection this seat sends WhatsApp template steps from: the salesperson's own WhatsApp Business number, connected in Nexus (app_topolo_nexus.whatsapp.connections.list lists the organization's connections). A WhatsApp step sends from the enrolled contact's seat connection, else the workspace setting (sending.whatsapp.update), else the organization default. Engage stores only the id; a connection Nexus does not know holds the step as whatsapp_not_configured. Audited. Nothing is sent. Verify with seats.get; roll back by setting the previous value.

Outcome

Set (or clear with null) the Nexus WhatsApp connection this seat sends WhatsApp template steps from: the salesperson's own WhatsApp Business number, connected in Nexus (app_topolo_nexus.whatsapp.connections.list lists the organization's connections). A WhatsApp step sends from the enrolled contact's seat connection, else the workspace setting (sending.whatsapp.update), else the organization default. Engage stores only the id; a connection Nexus does not know holds the step as whatsapp_not_configured. Audited. Nothing is sent. Verify with seats.get; roll back by setting the previous value.

Before you start

  • Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:write.
  • Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.
  • Review the exact effects and obtain approval before CLI --confirm or MCP confirm:true. A local capture does not authorize a live mutation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.seats.whatsapp.set --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
idYes{"type":"string","minLength":1,"maxLength":128}
connectionIdYes{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.seats.whatsapp.set --data @payload.json --json
topolo actions plan app_topolo_engage.seats.whatsapp.set --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

Review the plan and approve its exact effects before executing the unchanged request.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.seats.whatsapp.set --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · seat WhatsApp number > a WhatsApp step sends from the seat's own number over the workspace connection

Action input

{
  "id": "eng_seat_1",
  "connectionId": "wac_ash"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": "wac_ash",
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: seat WhatsApp number > a WhatsApp step sends from the seat's own number over the workspace connection. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · seat WhatsApp number > sets, trims and clears the number, audited with the previous value, and only for writers

Action input

{
  "id": "eng_seat_1",
  "connectionId": null
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: seat WhatsApp number > sets, trims and clears the number, audited with the previous value, and only for writers. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Set (or clear with null) the Nexus WhatsApp connection this seat sends WhatsApp template steps from: the salesperson's own WhatsApp Business number, connected in Nexus (app_topolo_nexus.whatsapp.connections.list lists the organization's connections). A WhatsApp step sends from the enrolled contact's seat connection, else the workspace setting (sending.whatsapp.update), else the organization default. Engage stores only the id; a connection Nexus does not know holds the step as whatsapp_not_configured. Audited. Nothing is sent. Verify with seats.get; roll back by setting the previous value.

Verify the outcome

  • Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 403 · seat WhatsApp number > sets, trims and clears the number, audited with the previous value, and only for writers

Action input

{
  "id": "eng_seat_1",
  "connectionId": "wac_ash"
}

Actual local response

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

Source test: seat WhatsApp number > sets, trims and clears the number, audited with the previous value, and only for writers. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id

Action input

{
  "id": "eng_seat_missing",
  "connectionId": "wac_1"
}

Actual local response

{
  "error": {
    "code": "not_found",
    "message": "Seat was not found in this workspace."
  }
}

Source test: seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id

Refused input; do not execute

{
  "connectionId": "",
  "id": "eng_seat_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for seats.whatsapp.set is invalid.",
    "details": [
      {
        "origin": "string",
        "code": "too_small",
        "minimum": 1,
        "inclusive": true,
        "path": [
          "connectionId"
        ],
        "message": "Too small: expected string to have >=1 characters"
      }
    ]
  }
}

Source test: seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id

Action input

{
  "id": "eng_seat_1",
  "connectionId": "wac_1"
}

Actual local response

{
  "error": {
    "code": "not_found",
    "message": "Seat was not found in this workspace."
  }
}

Source test: seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id

Refused input; do not execute

{
  "id": "eng_seat_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for seats.whatsapp.set is invalid.",
    "details": [
      {
        "expected": "string",
        "code": "invalid_type",
        "path": [
          "connectionId"
        ],
        "message": "Invalid input: expected string, received undefined"
      }
    ]
  }
}

Source test: seat WhatsApp number > refuses an unknown seat, another workspace's seat and a malformed id. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

  • HTTP 403 permission_denied: Stop and inspect the current credential and selected resource. It needs workspace:write; do not broaden access or switch organization automatically.
  • HTTP 404 not_found: Rediscover the identifier using the related list or get action in the same authorized resource. Do not guess identifiers or change organization context.
  • HTTP 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.

Evidence and limits

  • /api/seats/{id}/whatsapp

  • Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

  • Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

  • No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.