---
title: "Create a Flow Execution"
method: POST
path: "/channel/whatsapp/flow/{id}/run"
tags: ["Flows"]
---

# Create a Flow Execution

`POST /channel/whatsapp/flow/{id}/run`

## Request

- Base URL: `https://{youraccountname}.api-us1.com/api/3`
- URL: `https://{youraccountname}.api-us1.com/api/3/channel/whatsapp/flow/{id}/run`
- Auth: API key in header `Token`

Create a Flow Execution of a Flow.

## Path parameters

- `id` string, uuid, required

## Request body

- FlowExecutionCreateRequest
  - `execute_for` 'LIST', required: * `LIST` - LIST
  - `has_priority` boolean: Specify as True if you want this execution to close any other running flows or conversations.
  - `contact_list` PatchedContactEdit[], required
    - `phone` string
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, email, nullable
    - `meta` unknown
    - `external_url` string, uri, nullable
    - `is_deleted` boolean
    - `id` string, uuid
    - `source` string
    - `notes` ContactNote[]
      - `id` integer, required
      - `notes` string, required
      - `contact` string, uuid, required
      - `created_on` string, date-time, required
      - `created_by` SimpleUser
        - `first_name` string
        - `last_name` string
        - `email` string, email, required
        - `id` integer, required
        - `profile_image` string, uri, nullable
        - `role` integer, nullable
    - `created_on` string, date-time
    - `tags` ContactTag[]
      - `id` integer, required
      - `name` string, required
    - `external_id` string, nullable
    - `native_id` string, nullable
    - `default_assignees` integer[]
    - `contact_import` string, uuid, nullable
    - `default_channel` integer, nullable
    - `wa_id` string, nullable
    - `overwrite_tags` boolean: If true, the `tags` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.
    - `overwrite_default_assignees` boolean: If true, the `default_assignees` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.
    - `overwrite_meta` boolean: If true, the `meta` field will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.

## Response `201`

- FlowExecutionEdit
  - `status` string, required: The status of the Flow Execution.
  - `execute_for` 'FILTERS' | 'LIST' | 'ALL', required: * `FILTERS` - Filters * `LIST` - List * `ALL` - All
  - `id` string, uuid
  - `has_priority` boolean
  - `flow_execution_variables` unknown
  - `start_on` string, date-time, nullable
  - `num_contacts` integer
  - `expired` integer
  - `running` integer
  - `completed` integer
  - `canceled` integer
  - `failed` integer
  - `created_on` string, date-time
  - `avg_completion_time` string
  - `status_reason` string, nullable, required
  - `status_triggered_by` integer, nullable, required
  - `status_last_change_on` string, date-time, nullable, required
  - `contact_filters` FlowExecutionContactFilterEdit[]: The filters to use to get the Contacts that the Flow Execution will run for.
    - `field` string, required
    - `comparison` 'exact' | '!exact' | 'gte' | 'gt' | 'lte' | 'lt' | 'isnull' | '!isnull' | 'icontains' | '!icontains', required: * `exact` - Exact * `!exact` - Different * `gte` - Gte * `gt` - Gt * `lte` - Lte * `lt` - Lt * `isnull` - Is Null * `!isnull` - Not Null * `icontains` - Contains * `!icontains` - Not Contains
    - `value` string, required
    - `id` string, uuid
  - `contact_list` PatchedContactEdit[]: The list of Contacts that the Flow Execution will run for.
    - `phone` string
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, email, nullable
    - `meta` unknown
    - `external_url` string, uri, nullable
    - `is_deleted` boolean
    - `id` string, uuid
    - `source` string
    - `notes` ContactNote[]
      - `id` integer, required
      - `notes` string, required
      - `contact` string, uuid, required
      - `created_on` string, date-time, required
      - `created_by` SimpleUser
        - `first_name` string
        - `last_name` string
        - `email` string, email, required
        - `id` integer, required
        - `profile_image` string, uri, nullable
        - `role` integer, nullable
    - `created_on` string, date-time
    - `tags` ContactTag[]
      - `id` integer, required
      - `name` string, required
    - `external_id` string, nullable
    - `native_id` string, nullable
    - `default_assignees` integer[]
    - `contact_import` string, uuid, nullable
    - `default_channel` integer, nullable
    - `wa_id` string, nullable
    - `overwrite_tags` boolean: If true, the `tags` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.
    - `overwrite_default_assignees` boolean: If true, the `default_assignees` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.
    - `overwrite_meta` boolean: If true, the `meta` field will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.
  - `source` 'HUBSPOT' | 'API' | 'FRONTEND': * `HUBSPOT` - Hubspot * `API` - Api * `FRONTEND` - Frontend
  - `is_hidden` boolean

---

[API](https://skmtc.dev/activecampaign/apis/whatsapp-api.md) - [All operations](https://skmtc.dev/activecampaign/apis/whatsapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/activecampaign/apis/whatsapp-api/revisions/6c7855d91b4d?raw)