Skip to content

Docs / All tools / Loop IV: Validation

validation.run.stop

Stop a validation run and cancel any company search in progress. Completed work is billed as usual.

0 credits. Free: a stop is free. Companies its search already found are charged 6 each.

Example prompt

Send this to your AI app when Heelo is connected:

Stop my validation run. Send no more e-mails.

Input fields

FieldTypeDescription
run_idRequiredstring
reasonstringWhy your user stops the run

Code

The call with the input fields that the tool needs. Replace each word in capitals, such as RUN_ID. Set HEELO_API_KEY to your API key.

import os
import requests

response = requests.post(
    "https://toolsprimitives.uk/v1/tools/validation.run.stop/invoke",
    headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
    json={"input": {
        "run_id": "RUN_ID",
    }},
    timeout=120,
)
response.raise_for_status()
print(response.json())