Request double opt-in confirmation

Start double opt-in for a contact and an active topic: records subscribe_requested (state pending_confirmation) and returns confirmationUrl, a signed single-use link valid for 7 days (only its hash is stored). Opening the link (GET) only shows a page with a Confirm subscription button and never changes state, so email link scanners cannot confirm; the button POSTs the token, which confirms the subscription with double_opt_in evidence. With a verified sender (sending_settings) Nurture emails the link through Nexus (transactional, service_notice) and reports it in email; without one email.status is not_configured: deliver confirmationUrl yourself. Never confirm on the contact's behalf.

Outcome

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 read_write. 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.subscriptions.request_confirmation --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.contacts.list --detail --json

id: Nurture contact id in the selected workspace.

Request

POST /api/contacts/{id}/subscriptions/{topicKey}/request-confirmation

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

Field	Required	Type	Constraints
`id`	Required	string	Nurture contact id in the selected workspace. {"minLength":1,"maxLength":64}
`topicKey`	Required	string	{"pattern":"^[a-z0-9][a-z0-9_-]{0,62}$"}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "topicKey": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$"
    }
  },
  "required": [
    "id",
    "topicKey"
  ],
  "additionalProperties": false
}

Effects

Stores the confirmation token hash and appends subscribe_requested; the contact becomes pending_confirmation. With a verified sender, emails the confirmation link through Nexus as the caller (email.delivery nexus); it cannot be recalled.

Interpret the response

The returned identifier path is $.subscription.topicKey for contact_subscription. Empty lists do not discover a target.

Call app_topolo_nurture.subscriptions.list and confirm state pending_confirmation; after the contact presses Confirm subscription on the link's page, state subscribed.

Exact success schema:

{
  "type": "object",
  "required": [
    "subscription",
    "confirmationUrl",
    "expiresAt",
    "email"
  ],
  "properties": {
    "subscription": {
      "type": "object",
      "required": [
        "topicKey",
        "state"
      ],
      "properties": {
        "topicKey": {
          "type": "string"
        },
        "topicId": {
          "type": "string"
        },
        "topicName": {
          "type": "string"
        },
        "doubleOptIn": {
          "type": "boolean"
        },
        "state": {
          "type": "string",
          "enum": [
            "none",
            "pending_confirmation",
            "subscribed",
            "unsubscribed"
          ]
        },
        "since": {
          "type": [
            "string",
            "null"
          ]
        },
        "evidence": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object"
          }
        }
      }
    },
    "confirmationUrl": {
      "type": "string"
    },
    "expiresAt": {
      "type": "string"
    },
    "email": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "not_configured",
            "intended",
            "blocked",
            "deferred",
            "failed"
          ]
        },
        "reasons": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "delivery": {
          "type": "string",
          "enum": [
            "nexus",
            "queued"
          ]
        },
        "nexusMessageId": {
          "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:

{
  "id": "nct_f4095688094d4d2dbdfe8c7286d89d25",
  "topicKey": "news"
}

CLI:

topolo actions validate app_topolo_nurture.subscriptions.request_confirmation --data @payload.json --json
topolo actions plan app_topolo_nurture.subscriptions.request_confirmation --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.subscriptions.request_confirmation --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.subscriptions.request_confirmation",
    "input": {
      "id": "nct_f4095688094d4d2dbdfe8c7286d89d25",
      "topicKey": "news"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "subscription": {
    "topicKey": "news",
    "topicId": "topic_7feb1bf0f64f4a0497785ee3dcb4fbea",
    "topicName": "News",
    "doubleOptIn": true,
    "state": "pending_confirmation",
    "since": "2026-10-01T00:24:00.001Z",
    "evidence": null
  },
  "confirmationUrl": "https://nurture.test/api/public/confirm?token=eyJ2IjoxLCJrIjoiY29uZmlybSIsIm8iOiJvcmdfYSIsInciOiJ3c19hIiwiYyI6Im5jdF9mNDA5NTY4ODA5NGQ0ZDJkYmRmZThjNzI4NmQ4OWQyNSIsIm4iOiJuX2QwNDYxNzMwZGRjMDQzNGRiZTJkN2I2MjkyMzE2YWM3IiwidCI6Im5ld3MiLCJlIjoxNzkxNDE5MDQwMDAxfQ.3hVTaIBaQLghJCC3cSHQtg5auHejMqrMk4khYUcRUzU",
  "expiresAt": "2026-10-08T00:24:00.001Z",
  "email": {
    "status": "not_configured"
  }
}

HTTP 201. Call app_topolo_nurture.subscriptions.list and confirm state pending_confirmation; after the contact presses Confirm subscription on the link's page, state subscribed.

Another supported request

Input · payload.json:

{
  "id": "nct_024c953635eb499f85767bdbcc80b7db",
  "topicKey": "news"
}

CLI:

topolo actions validate app_topolo_nurture.subscriptions.request_confirmation --data @payload.json --json
topolo actions plan app_topolo_nurture.subscriptions.request_confirmation --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.subscriptions.request_confirmation --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.subscriptions.request_confirmation",
    "input": {
      "id": "nct_024c953635eb499f85767bdbcc80b7db",
      "topicKey": "news"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "subscription": {
    "topicKey": "news",
    "topicId": "topic_1df9c31100a14a81ab8defcabc7d2a3d",
    "topicName": "News",
    "doubleOptIn": true,
    "state": "pending_confirmation",
    "since": "2026-10-01T00:24:00.001Z",
    "evidence": null
  },
  "confirmationUrl": "https://nurture.test/api/public/confirm?token=eyJ2IjoxLCJrIjoiY29uZmlybSIsIm8iOiJvcmdfYSIsInciOiJ3c19hIiwiYyI6Im5jdF8wMjRjOTUzNjM1ZWI0OTlmODU3NjdiZGJjYzgwYjdkYiIsIm4iOiJuXzM4YzU3YThiODMxNjQzZWU5NTY4NzVhOTcyYmM1YjFkIiwidCI6Im5ld3MiLCJlIjoxNzkxNDE5MDQwMDAxfQ.-8t8zDxMgrCsbPTENcULMiJvPjxwH4vqG20zdThGdSo",
  "expiresAt": "2026-10-08T00:24:00.001Z",
  "email": {
    "status": "not_configured"
  }
}

HTTP 201. Call app_topolo_nurture.subscriptions.list and confirm state pending_confirmation; after the contact presses Confirm subscription on the link's page, state subscribed.

Refused request · root_key_unavailable

Input · payload.json:

{
  "id": "nct_54a0a9a8a2c048018ba26ac8a6b3a720",
  "topicKey": "news"
}

CLI:

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

Captured local response · HTTP 503:

{
  "error": {
    "code": "root_key_unavailable",
    "message": "The Nurture application root key is not available, so tokens cannot be signed."
  }
}

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

Refused request · public_url_unavailable

Input · payload.json:

{
  "id": "nct_54a0a9a8a2c048018ba26ac8a6b3a720",
  "topicKey": "news"
}

CLI:

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

Captured local response · HTTP 503:

{
  "error": {
    "code": "public_url_unavailable",
    "message": "NURTURE_PUBLIC_URL is not configured, so no public link can be built."
  }
}

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

Refused request · not_found

Input · payload.json:

{
  "id": "nct_4945f75a6f054baa89c0d210c36204ed",
  "topicKey": "news"
}

CLI:

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

Captured local response · HTTP 404:

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

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

Verify the result

Call app_topolo_nurture.subscriptions.list and confirm state pending_confirmation; after the contact presses Confirm subscription on the link's page, state subscribed.

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.
not_found (HTTP 404): List contacts to find a valid id in this workspace.
topic_unavailable (HTTP 422): Call app_topolo_nurture.subscription_topics.list and use the key of an active topic.
root_key_unavailable (HTTP 503): Tokens cannot be signed until the application root key is provisioned; check app_topolo_nurture.root_key.status and ask an operator to provision it.
public_url_unavailable (HTTP 503): NURTURE_PUBLIC_URL is not configured for this environment; ask an operator.
already_subscribed (HTTP 409): Nothing to confirm; the contact is already subscribed.

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

A pending request expires on its own; unsubscribe to record that the contact must not be subscribed.

List contact subscriptions: Read a contact's subscription state for every active topic of the workspace: none, pending_confirmation, subscribed or unsubscribed, with since and the evidence that subscribed them. State is resolved by @topolo-io/audience from Nurture's own subscription stream and suppression ledger; an unsubscribe is always a ledger event.
Unsubscribe contact from topic: Unsubscribe a contact from one topic (active or archived) by appending a topic-scoped unsubscribed event to the suppression ledger, the single source of unsubscribes. Marketing for that topic is blocked until the contact re-subscribes with double opt-in or a consent decision.

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.

Request double opt-in confirmation

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · root_key_unavailable

Refused request · public_url_unavailable

Refused request · not_found

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence