Topolo Docs Topolo Platform
Open workspace

Record suppression event

Append one event to the contact's suppression ledger. Blocking events: unsubscribed (all marketing, or one topic with topicKey), hard_bounce, complaint, wrong_person (these three apply org-wide to the address), reply_stop, not_interested (outreach), manual_block (everything). Loosening events need evidence: deliverable (clears hard_bounce) needs verification; repermissioned (clears unsubscribed, reply_stop, not_interested) needs consent_decision, and clearing a complaint also needs verification; manual_unblock (clears manual_block) is an operator action. import_attestation never lifts a block. double_opt_in evidence cannot be sent here; it is produced only by the public confirmation link.

Outcome

Append one event to the contact's suppression ledger. Blocking events: unsubscribed (all marketing, or one topic with topicKey), hard_bounce, complaint, wrong_person (these three apply org-wide to the address), reply_stop, not_interested (outreach), manual_block (everything). Loosening events need evidence: deliverable (clears hard_bounce) needs verification; repermissioned (clears unsubscribed, reply_stop, not_interested) needs consent_decision, and clearing a complaint also needs verification; manual_unblock (clears manual_block) is an operator action. import_attestation never lifts a block. double_opt_in evidence cannot be sent here; it is produced only by the public confirmation link.

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.suppressions.record --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}/suppressions

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
idRequiredstringNurture contact id in the selected workspace. {"minLength":1,"maxLength":64}
eventTypeRequiredstring{"enum":["unsubscribed","repermissioned","hard_bounce","deliverable","complaint","reply_stop","not_interested","wrong_person","manual_block","manual_unblock"]}
topicKeyOptionalstring{"pattern":"^[a-z0-9][a-z0-9_-]{0,62}$"}
reasonOptionalstring{"minLength":1,"maxLength":500}
evidenceOptionalarray{"maxItems":3}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "eventType": {
      "type": "string",
      "enum": [
        "unsubscribed",
        "repermissioned",
        "hard_bounce",
        "deliverable",
        "complaint",
        "reply_stop",
        "not_interested",
        "wrong_person",
        "manual_block",
        "manual_unblock"
      ]
    },
    "topicKey": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$"
    },
    "reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "evidence": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "consent_decision"
              },
              "provider": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "decisionRef": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "purposeId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              }
            },
            "required": [
              "kind",
              "provider",
              "decisionRef",
              "purposeId"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "verification"
              },
              "method": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "provider": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "verifiedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              }
            },
            "required": [
              "kind",
              "method",
              "verifiedAt"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "import_attestation"
              },
              "importId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "lawfulBasis": {
                "type": "string",
                "enum": [
                  "consent",
                  "legitimate_interest",
                  "contract"
                ]
              }
            },
            "required": [
              "kind",
              "importId",
              "lawfulBasis"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "id",
    "eventType"
  ],
  "additionalProperties": false
}

Effects

  • Appends one ledger event (source app_topolo_nurture) and returns the resolved blocks. Address-scoped events affect every workspace of the organization.

Interpret the response

The returned identifier path is $.recorded for suppression_event. Empty lists do not discover a target.

Call app_topolo_nurture.suppressions.list and confirm the expected block appears or disappears.

Exact success schema:

{
  "type": "object",
  "required": [
    "contactId",
    "blocks",
    "events"
  ],
  "properties": {
    "contactId": {
      "type": "string"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "code",
          "purpose",
          "scope",
          "since"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "purpose": {
            "type": "string",
            "enum": [
              "marketing",
              "outreach",
              "all"
            ]
          },
          "scope": {
            "type": "string",
            "enum": [
              "contact",
              "address"
            ]
          },
          "topicKey": {
            "type": "string"
          },
          "since": {
            "type": "string"
          },
          "sourceApp": {
            "type": "string"
          }
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "idempotencyKey",
          "type",
          "scope",
          "occurredAt"
        ],
        "properties": {
          "idempotencyKey": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "scope": {
            "type": "string",
            "enum": [
              "contact",
              "address"
            ]
          },
          "topicKey": {
            "type": "string"
          },
          "occurredAt": {
            "type": "string"
          },
          "sourceApp": {
            "type": "string"
          },
          "reason": {
            "type": [
              "string",
              "null"
            ]
          },
          "evidenceKinds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "recorded": {
      "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_e5477c912eff49b8949f71490c2ded25",
  "eventType": "complaint"
}

CLI:

topolo actions validate app_topolo_nurture.suppressions.record --data @payload.json --json
topolo actions plan app_topolo_nurture.suppressions.record --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.suppressions.record --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.suppressions.record",
    "input": {
      "id": "nct_e5477c912eff49b8949f71490c2ded25",
      "eventType": "complaint"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "contactId": "nct_e5477c912eff49b8949f71490c2ded25",
  "recorded": "led_f9befe6170df40a68a658da668ba1b2a",
  "blocks": [
    {
      "code": "complaint",
      "purpose": "marketing",
      "scope": "address",
      "since": "2026-10-04T00:32:36.440Z",
      "sourceApp": "app_topolo_nurture"
    },
    {
      "code": "complaint",
      "purpose": "outreach",
      "scope": "address",
      "since": "2026-10-04T00:32:36.440Z",
      "sourceApp": "app_topolo_nurture"
    },
    {
      "code": "manual_block",
      "purpose": "all",
      "scope": "contact",
      "since": "2026-10-04T00:32:36.431Z",
      "sourceApp": "app_topolo_nurture"
    },
    {
      "code": "wrong_person",
      "purpose": "all",
      "scope": "address",
      "since": "2026-10-04T00:32:36.432Z",
      "sourceApp": "app_topolo_nurture"
    }
  ],
  "events": [
    {
      "idempotencyKey": "led_31f7bd15d24f4642b9d56091ae41c9f2",
      "type": "manual_block",
      "scope": "contact",
      "occurredAt": "2026-10-04T00:32:36.431Z",
      "sourceApp": "app_topolo_nurture",
      "reason": "asked",
      "evidenceKinds": []
    },
    {
      "idempotencyKey": "led_9cbd432b0d1b4a9abe41aeea252a909d",
      "type": "wrong_person",
      "scope": "address",
      "occurredAt": "2026-10-04T00:32:36.432Z",
      "sourceApp": "app_topolo_nurture",
      "reason": null,
      "evidenceKinds": []
    },
    {
      "idempotencyKey": "led_f9befe6170df40a68a658da668ba1b2a",
      "type": "complaint",
      "scope": "address",
      "occurredAt": "2026-10-04T00:32:36.440Z",
      "sourceApp": "app_topolo_nurture",
      "reason": null,
      "evidenceKinds": []
    }
  ]
}

HTTP 201. Call app_topolo_nurture.suppressions.list and confirm the expected block appears or disappears.

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:

{
  "id": "nct_e5477c912eff49b8949f71490c2ded25",
  "eventType": "wrong_person"
}

CLI:

topolo actions validate app_topolo_nurture.suppressions.record --data @payload.json --json
topolo actions plan app_topolo_nurture.suppressions.record --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.suppressions.record --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.suppressions.record",
    "input": {
      "id": "nct_e5477c912eff49b8949f71490c2ded25",
      "eventType": "wrong_person"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "contactId": "nct_e5477c912eff49b8949f71490c2ded25",
  "recorded": "led_9cbd432b0d1b4a9abe41aeea252a909d",
  "blocks": [
    {
      "code": "manual_block",
      "purpose": "all",
      "scope": "contact",
      "since": "2026-10-04T00:32:36.431Z",
      "sourceApp": "app_topolo_nurture"
    },
    {
      "code": "wrong_person",
      "purpose": "all",
      "scope": "address",
      "since": "2026-10-04T00:32:36.432Z",
      "sourceApp": "app_topolo_nurture"
    }
  ],
  "events": [
    {
      "idempotencyKey": "led_31f7bd15d24f4642b9d56091ae41c9f2",
      "type": "manual_block",
      "scope": "contact",
      "occurredAt": "2026-10-04T00:32:36.431Z",
      "sourceApp": "app_topolo_nurture",
      "reason": "asked",
      "evidenceKinds": []
    },
    {
      "idempotencyKey": "led_9cbd432b0d1b4a9abe41aeea252a909d",
      "type": "wrong_person",
      "scope": "address",
      "occurredAt": "2026-10-04T00:32:36.432Z",
      "sourceApp": "app_topolo_nurture",
      "reason": null,
      "evidenceKinds": []
    }
  ]
}

HTTP 201. Call app_topolo_nurture.suppressions.list and confirm the expected block appears or disappears.

Refused request · loosening_evidence_required

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_204ccdfc09534af7bb7e9b383040a352",
  "eventType": "repermissioned",
  "reason": "try",
  "evidence": [
    {
      "kind": "verification",
      "method": "mx",
      "verifiedAt": "2026-10-01T00:00:00Z"
    }
  ]
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "loosening_evidence_required",
    "message": "Lifting this block needs stronger evidence.",
    "details": {
      "reason": "opt_in_or_consent_required"
    }
  }
}

HTTP 422. 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:

{
  "eventType": "erased",
  "id": "nct_204ccdfc09534af7bb7e9b383040a352"
}

CLI:

topolo actions validate app_topolo_nurture.suppressions.record --data @payload.json --json
topolo actions plan app_topolo_nurture.suppressions.record --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": [
      {
        "code": "invalid_value",
        "values": [
          "unsubscribed",
          "repermissioned",
          "hard_bounce",
          "deliverable",
          "complaint",
          "reply_stop",
          "not_interested",
          "wrong_person",
          "manual_block",
          "manual_unblock"
        ],
        "path": [
          "eventType"
        ],
        "message": "Invalid option: expected one of \"unsubscribed\"|\"repermissioned\"|\"hard_bounce\"|\"deliverable\"|\"complaint\"|\"reply_stop\"|\"not_interested\"|\"wrong_person\"|\"manual_block\"|\"manual_unblock\""
      }
    ]
  }
}

HTTP 422. 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:

{
  "id": "nct_d6dce1df14ce45e6af6c01277b01fe8f",
  "eventType": "manual_unblock"
}

CLI:

topolo actions validate app_topolo_nurture.suppressions.record --data @payload.json --json
topolo actions plan app_topolo_nurture.suppressions.record --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.suppressions.list and confirm the expected block appears or disappears.

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.
  • topic_not_applicable (HTTP 422): Only send topicKey with unsubscribed or repermissioned.
  • loosening_evidence_required (HTTP 422): See error.details.reason: verification_required, opt_in_or_consent_required or import_attestation_not_allowed; attach the evidence the rule needs, or leave the block in place.

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

The ledger is append-only: record the opposite event (manual_unblock after manual_block; deliverable or repermissioned with evidence) instead of deleting.

  • List contact suppressions: Read the suppression blocks currently active for a contact (resolved by @topolo-io/audience, stricter wins) and the ledger events behind them. Address-scoped events (hard_bounce, deliverable, complaint, wrong_person, and erased, which contacts.erase records and nothing lifts) are keyed by the org-scoped address hash and apply across every workspace of the organization, so events may come from other workspaces; events are therefore shown without contact ids, address hashes or evidence details.
  • Record suppression event: Append one event to the contact's suppression ledger. Blocking events: unsubscribed (all marketing, or one topic with topicKey), hard_bounce, complaint, wrong_person (these three apply org-wide to the address), reply_stop, not_interested (outreach), manual_block (everything). Loosening events need evidence: deliverable (clears hard_bounce) needs verification; repermissioned (clears unsubscribed, reply_stop, not_interested) needs consent_decision, and clearing a complaint also needs verification; manual_unblock (clears manual_block) is an operator action. import_attestation never lifts a block. double_opt_in evidence cannot be sent here; it is produced only by the public confirmation link.

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.