ToolsSequences

Mark company

Set do_not_contact and/or qualification_status on a company.

Tool: mark_company

do_not_contact=true cascades to the company's people and stops their active enrollments; false lifts only the company flag.

Parameters

ParamTypeRequiredDescription
company_idstring (slug or UUID)noThe company. One of company_id / domain is required.
domainstringnoOR the company domain - must match exactly one company, else ambiguous_match.
do_not_contactbooleannotrue cascades to the company's people and stops their active enrollments; false lifts only the company flag (people keep their individual flags).
qualification_statusstringnonew | qualified | disqualified | customer.

Pass at least one of do_not_contact / qualification_status; omitted fields are untouched.

Sample request — customer

{
  "domain": "globex.example",
  "qualification_status": "customer"
}

Sample request — lift do not contact

{
  "domain": "initech.example",
  "do_not_contact": false
}

On this page