task_rule_action

One step of a rule. action_name decides which of the other keys are read — the rest are ignored.

Which actions a rule may use depends on the subject its trigger acts on: a deal accepts create_task, move_stage, assign_owner, change_status, send_message and add_label; a contact accepts create_deal, create_task, send_message and add_label; a task accepts create_task, move_stage and send_message; a company accepts create_task, send_webhook, send_message and add_label; a product, service or pipeline accepts create_task and send_webhook.

action_namestring

Possible values: [create_task, move_stage, assign_owner, change_status, create_deal, send_message, send_webhook, add_label]

task_typestring

create_task — the key of a task type

title_templatestring

create_task — supports the account's dynamic variables

description_templatestring

create_task

delay_daysinteger

create_task — how far out the due date lands

delay_hoursinteger

create_task

prioritystring

create_task

Possible values: [low, medium, high]

owner_strategystring

create_task and create_deal — who ends up responsible. unassigned only applies to create_deal, which has no deal owner to inherit from.

Possible values: [deal_owner, specific_user, round_robin, unassigned]

owner_idinteger

Used when owner_strategy is specific_user

deal_pipeline_idinteger

create_deal and move_stage

deal_stage_idinteger

create_deal and move_stage

statusstring

change_status

Possible values: [ongoing, won, lost, paused]

lost_reason_idinteger

change_status, when the new status is lost

name_templatestring

create_deal — the name of the deal that gets opened

skip_if_open_dealboolean

create_deal — do nothing when the contact already has an open deal

content_templatestring

send_message — supports the account's dynamic variables

webhook_urlstring

send_webhook

labelsstring[]

add_label

task_rule_action

{
  "action_name": "create_task",
  "task_type": "string",
  "title_template": "string",
  "description_template": "string",
  "delay_days": 0,
  "delay_hours": 0,
  "priority": "low",
  "owner_strategy": "deal_owner",
  "owner_id": 0,
  "deal_pipeline_id": 0,
  "deal_stage_id": 0,
  "status": "ongoing",
  "lost_reason_id": 0,
  "name_template": "string",
  "skip_if_open_deal": true,
  "content_template": "string",
  "webhook_url": "string",
  "labels": [
    "string"
  ]
}