Topolo Docs Topolo Platform
Open workspace

Reserve a send slot

Check eligibility for one contact and, when eligible, atomically reserve a send slot that counts toward the caps for 15 minutes (or until released). Idempotent by idempotencyKey: a repeat returns the same live reservation without re-counting caps, or granted false with reservation_expired once released or expired. Applies the same suppression, subscription and pacing rules as app_topolo_nurture.eligibility.check; transactional messages need messageCategory. For marketing and outreach a granted reservation includes listUnsubscribe: a signed one-click unsubscribe URL and POST body for the message body. Nexus owns the List-Unsubscribe headers; pass the preference centre to email.send as unsubscribe_landing_url. With an active suppression_sync connector, a connector-sourced contact is also reserved in that system (TopoloCRM eligibility.reserve) and the stricter answer wins: a remote refusal releases the Nurture reservation and returns its reasons. Sends nothing.

Outcome

Check eligibility for one contact and, when eligible, atomically reserve a send slot that counts toward the caps for 15 minutes (or until released). Idempotent by idempotencyKey: a repeat returns the same live reservation without re-counting caps, or granted false with reservation_expired once released or expired. Applies the same suppression, subscription and pacing rules as app_topolo_nurture.eligibility.check; transactional messages need messageCategory. For marketing and outreach a granted reservation includes listUnsubscribe: a signed one-click unsubscribe URL and POST body for the message body. Nexus owns the List-Unsubscribe headers; pass the preference centre to email.send as unsubscribe_landing_url. With an active suppression_sync connector, a connector-sourced contact is also reserved in that system (TopoloCRM eligibility.reserve) and the stricter answer wins: a remote refusal releases the Nurture reservation and returns its reasons. Sends nothing.

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.eligibility.reserve --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.contacts.list --detail --json
  • contactId: Nurture contact id; this is not a CRM contact id.

Request

POST /api/eligibility/reservations

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
purposeRequiredstring{"enum":["marketing","outreach","transactional"]}
messageCategoryOptionalstring{"enum":["receipt","password_reset","account_security","billing","order_update","service_notice"]}
channelRequiredstring{"const":"email"}
topicKeyOptionalstring{"pattern":"^[a-z0-9][a-z0-9_-]{0,62}$"}
contactIdRequiredstringNurture contact id; this is not a CRM contact id. {"minLength":1,"maxLength":64}
idempotencyKeyRequiredstring{"minLength":8,"maxLength":200}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "purpose": {
      "type": "string",
      "enum": [
        "marketing",
        "outreach",
        "transactional"
      ]
    },
    "messageCategory": {
      "type": "string",
      "enum": [
        "receipt",
        "password_reset",
        "account_security",
        "billing",
        "order_update",
        "service_notice"
      ]
    },
    "channel": {
      "type": "string",
      "const": "email"
    },
    "topicKey": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$"
    },
    "contactId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  },
  "required": [
    "purpose",
    "channel",
    "contactId",
    "idempotencyKey"
  ],
  "additionalProperties": false
}

Effects

  • When granted, stores one reserved send for the contact that counts toward daily and weekly caps until it expires or is released.
  • With an active suppression_sync connector and a connector-sourced contact, also reserves a slot in the remote system as the caller; a remote refusal releases the Nurture reservation (granted false, combined reasons).

Interpret the response

An allowed reservation can return an id, while a refused eligibility decision can return no reservation. Inspect allowed and the decision details before using any reservation id.

Confirm granted is true and keep reservation.id; when false, read reasons[] and nextEligibleAt.

Exact success schema:

{
  "type": "object",
  "required": [
    "granted",
    "reasons"
  ],
  "properties": {
    "granted": {
      "type": "boolean"
    },
    "reasons": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "@topolo-io/audience reason codes, e.g. unsubscribed_topic, not_subscribed, subscription_pending, contact_point_undeliverable, complaint, manual_block, erased, daily_cap_reached, weekly_cap_reached, quiet_hours, transactional_category_required."
    },
    "nextEligibleAt": {
      "type": "string"
    },
    "reservation": {
      "type": "object",
      "required": [
        "id",
        "expiresAt"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string"
        }
      }
    },
    "listUnsubscribe": {
      "type": "object",
      "required": [
        "url",
        "post"
      ],
      "properties": {
        "url": {
          "type": "string"
        },
        "post": {
          "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:

{
  "purpose": "transactional",
  "messageCategory": "receipt",
  "channel": "email",
  "contactId": "nct_bd24766c41e8448a9620edffd8a208f7",
  "idempotencyKey": "receipt-0001"
}

CLI:

topolo actions validate app_topolo_nurture.eligibility.reserve --data @payload.json --json
topolo actions plan app_topolo_nurture.eligibility.reserve --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.eligibility.reserve --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.eligibility.reserve",
    "input": {
      "purpose": "transactional",
      "messageCategory": "receipt",
      "channel": "email",
      "contactId": "nct_bd24766c41e8448a9620edffd8a208f7",
      "idempotencyKey": "receipt-0001"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "granted": true,
  "reservation": {
    "id": "rsv_ffc0c7501faf490bb8d31b45544ee75b",
    "expiresAt": "2026-10-04T00:47:36.689Z"
  },
  "reasons": []
}

HTTP 200. Confirm granted is true and keep reservation.id; when false, read reasons[] and nextEligibleAt.

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:

{
  "purpose": "outreach",
  "channel": "email",
  "contactId": "nct_8cc96272162e4739b423db5e3d7a7fa1",
  "idempotencyKey": "send-linked-5"
}

CLI:

topolo actions validate app_topolo_nurture.eligibility.reserve --data @payload.json --json
topolo actions plan app_topolo_nurture.eligibility.reserve --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.eligibility.reserve --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.eligibility.reserve",
    "input": {
      "purpose": "outreach",
      "channel": "email",
      "contactId": "nct_8cc96272162e4739b423db5e3d7a7fa1",
      "idempotencyKey": "send-linked-5"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "granted": false,
  "reasons": [
    "manual_block"
  ]
}

HTTP 200. Confirm granted is true and keep reservation.id; when false, read reasons[] and nextEligibleAt.

Refused request · connector_unavailable

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:

{
  "purpose": "outreach",
  "channel": "email",
  "contactId": "nct_a7d43d7d8d7948478b4c3e300228f60d",
  "idempotencyKey": "send-linked-7"
}

CLI:

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

Captured local response · HTTP 502:

{
  "error": {
    "code": "connector_unavailable",
    "message": "The topolo_crm connector could not be reached: no credential for this provider",
    "details": {
      "connectorId": "con_5a3c0bca9e7044319fb55d6071cc07f3"
    }
  }
}

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

Refused request · not_found

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:

{
  "purpose": "marketing",
  "channel": "email",
  "topicKey": "news",
  "contactId": "nct_missing",
  "idempotencyKey": "k-00000001"
}

CLI:

topolo actions validate app_topolo_nurture.eligibility.reserve --data @payload.json --json
topolo actions plan app_topolo_nurture.eligibility.reserve --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.

Refused request · contact_archived

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:

{
  "purpose": "marketing",
  "channel": "email",
  "topicKey": "news",
  "contactId": "nct_c34eed4ba4154d20b4cfb49c16bbea70",
  "idempotencyKey": "k-00000001"
}

CLI:

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

Captured local response · HTTP 409:

{
  "error": {
    "code": "contact_archived",
    "message": "An archived contact cannot be sent to."
  }
}

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

Verify the result

  • Confirm granted is true and keep reservation.id; when false, read reasons[] and nextEligibleAt.

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.
  • topic_unavailable (HTTP 422): Call app_topolo_nurture.subscription_topics.list and use the key of an active topic, or omit topicKey.
  • not_found (HTTP 404): Call app_topolo_nurture.contacts.list to find a contact id in this workspace.
  • contact_archived (HTTP 409): Archived contacts are never sent to.
  • root_key_unavailable (HTTP 503): The unsubscribe link cannot be signed until the root key is provisioned; check app_topolo_nurture.root_key.status.
  • public_url_unavailable (HTTP 503): NURTURE_PUBLIC_URL is not configured for this environment; ask an operator.
  • connector_unavailable (HTTP 502): A delegating connector could not be reached (or this credential cannot reach it); nothing stays reserved. Retry, or pause the connector with app_topolo_nurture.connectors.update.

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

Release the reservation if the message will not be sent, so it stops counting toward caps.

  • Release a send reservation: Release an unused reservation so it stops counting toward the contact's caps. Releasing a reservation that is already released or consumed changes nothing. A remote reservation taken through a connector is released there too (remote[]).

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.