Built-in tool
Stop outreach to a person
Stop a person's remaining outreach steps in one Workflow or in every Workflow that has messaged them.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| emailstring · optional | string | optional | The person's email address. After Email Received it is the trigger's sender. Example: |
| linkedinMemberIdstring · optional | string | optional | The person's LinkedIn member id. After LinkedIn Message Received it is the trigger's sender id. Example: |
| chatIdstring · optional | string | optional | The LinkedIn or WhatsApp chat with the person. Not used for email. Example: |
| flowIdworkflow · optional | workflow | optional | Stop them in this Workflow only. Leave empty to stop them in every Workflow that has messaged them. Example: |
| recordIdstring · optional | string | optional | Their Record in the chosen Workflow, when known. Stops that run even before a message went out. Example: |
| reasonstring · optional | string | optional | A few words shown on each skipped step. Defaults to "outreach stopped". Example: |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success",
"stoppedCount",
"workflows",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "What happened, naming each Workflow the person was stopped in."
},
"success": {
"type": "boolean",
"description": "Whether the stop ran. Also true when nothing was left to stop."
},
"workflows": {
"type": "array",
"items": {
"type": "object",
"required": [
"flowId",
"workflowName",
"recordId",
"skippedSteps",
"signalledRuns"
],
"properties": {
"flowId": {
"type": "string"
},
"recordId": {
"type": "string",
"description": "The person's Record (run) in that Workflow."
},
"skippedSteps": {
"type": "number",
"description": "How many of their remaining steps were skipped."
},
"workflowName": {
"type": "string"
},
"signalledRuns": {
"type": "number",
"description": "How many running executions were told to stop (a wait in progress ends)."
}
},
"additionalProperties": false
},
"description": "One entry per Workflow run of this person that was found."
},
"stoppedCount": {
"type": "number",
"description": "How many of the person's Workflow runs had steps left and were stopped."
}
},
"additionalProperties": false
}
