Consume a send reservation

Outcome

Mark a reservation as used by the interaction that was sent. Idempotent for the same interactionId. Unknown or released reservations return 404 reservation_not_found; an expired one, or one consumed by another interaction, returns 409.

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.eligibility.reservations.consume --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

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.eligibility.reservations.consume --data @payload.json --json
topolo actions plan app_topolo_engage.eligibility.reservations.consume --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.eligibility.reservations.consume --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 · contactability routes > eligibility > reserves under the cap, replays a granted key, and counts consumed sends

Action input

{
  "id": "reservation_1",
  "interactionId": "int_1"
}

Actual local response

{
  "reservation": {
    "id": "reservation_1",
    "contactId": "contact_1",
    "purpose": "outreach",
    "status": "consumed",
    "plannedAt": "2026-10-01T12:00:00.000Z",
    "expiresAt": "2026-10-01T12:15:00.000Z",
    "interactionId": "int_1",
    "releaseReason": null
  }
}

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

• Mark a reservation as used by the interaction that was sent. Idempotent for the same interactionId. Unknown or released reservations return 404 reservation_not_found; an expired one, or one consumed by another interaction, returns 409.

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 409 · contactability routes > eligibility > reserves under the cap, replays a granted key, and counts consumed sends

Action input

{
  "id": "reservation_1",
  "interactionId": "int_2"
}

Actual local response

{
  "error": {
    "code": "state_conflict",
    "message": "The reservation was consumed by another interaction."
  }
}

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · contactability routes > eligibility > releases a reservation so it stops counting, and refuses expired or released ones

Action input

{
  "id": "reservation_1",
  "interactionId": "int_1"
}

Actual local response

{
  "error": {
    "code": "reservation_not_found",
    "message": "Reservation was not found in this workspace."
  }
}

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 409 · contactability routes > eligibility > releases a reservation so it stops counting, and refuses expired or released ones

Action input

{
  "id": "reservation_2",
  "interactionId": "int_1"
}

Actual local response

{
  "error": {
    "code": "reservation_expired",
    "message": "The reservation expired before it was consumed; reserve again."
  }
}

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 403 · contactability routes > eligibility > releases a reservation so it stops counting, and refuses expired or released ones

Action input

{
  "id": "reservation_1",
  "interactionId": "x"
}

Actual local response

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

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · contactability routes > eligibility > releases a reservation so it stops counting, and refuses expired or released ones

Action input

{
  "id": "eng_rsv_x",
  "interactionId": "x"
}

Actual local response

{
  "error": {
    "code": "reservation_not_found",
    "message": "Reservation was not found in this workspace."
  }
}

Source test: contactability-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

• HTTP 409 state_conflict: Read the current retained state and reconcile the requested transition before retrying. Do not blindly replay a non-idempotent mutation.
• HTTP 404 reservation_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 409 reservation_expired: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
• 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.

Related actions

• Check send eligibility
• Reserve a send slot
• Release a send reservation

Evidence and limits

• /api/eligibility/reservations/{id}/consume

• contactability-routes.test.ts

• 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.