ActiveCampaign Flows API

openapi: 3.2.0
info:
  title: WhatsApp Flows API
  version: 1.0.0
  description: 'All of the below API endpoints require API key authentication, get your token at https://app.hilos.io/dev/api-keys.


    To use this token, send with every request an `Authorization: Token <your token>` header.


    Production API server is located at api.hilos.io using HTTPS.


    No versioning info is required for now.'
servers:
- url: https://{youraccountname}.api-us1.com/api/3
  description: Production Server
tags:
- name: Flows
paths:
  /channel/whatsapp/flow-execution:
    get:
      operationId: List Flow Execution
      description: 'Lists Flow Executions. '
      summary: List Flow Executions
      parameters:
      - in: query
        name: flow
        schema:
          type: string
          format: uuid
        description: A Flow Id to filter the Flow Executions and only get those from that Flow.
        examples:
          OnlyReturnTheFlowExecutionsOfThisFlow:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Only return the Flow Executions of this Flow
      - in: query
        name: flow_version
        schema:
          type: string
          format: uuid
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - in: query
        name: search
        schema:
          type: string
        description: You can search with the `status`, `created_by__email` fields.
        examples:
          CreatedByEmail:
            value: erik@hilos.io
            summary: created by email
          With`PROCESSING`Status:
            value: Processing
            summary: with `PROCESSING` status
          With`READY`Status:
            value: Ready
            summary: with `READY` status
          With`AWAITINGCONFIRMATION`Status:
            value: Awaiting Confirmation
            summary: with `AWAITING_CONFIRMATION` status
          With`CONFIRMED`Status:
            value: Confirmed
            summary: with `CONFIRMED` status
          With`STARTING`Status:
            value: Starting
            summary: with `STARTING` status
          With`RUNNING`Status:
            value: Running
            summary: with `RUNNING` status
          With`COMPLETED`Status:
            value: Completed
            summary: with `COMPLETED` status
          With`CANCELED`Status:
            value: Canceled
            summary: with `CANCELED` status
      tags:
      - Flows
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFlowExecutionListList'
          description: ''
  /channel/whatsapp/flow-execution-contact:
    get:
      operationId: List Flow Execution Contact
      description: Lists Flow Execution Contacts.
      summary: List Flow Execution Contacts
      parameters:
      - in: query
        name: contact
        schema:
          type: string
          format: uuid
        description: A Contact Id to filter the Flow Execution Contacts and only get those from that Contact.
        examples:
          OnlyReturnTheFlowExecutionsContactOfThisContact:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Only return the Flow Executions Contact of this Contact
      - in: query
        name: execution_steps__step_id
        schema:
          type: string
          format: uuid
      - in: query
        name: flow
        schema:
          type: string
          format: uuid
        description: A Flow Id to filter the Flow Execution Contacts and only get those from that Flow.
        examples:
          OnlyReturnTheFlowExecutionsContactOfThisFlow:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Only return the Flow Executions Contact of this flow
      - in: query
        name: flow_execution
        schema:
          type: string
          format: uuid
        description: A Flow Execution Id to filter the Flow Execution Contacts and only get those from that Flow Execution.
        examples:
          OnlyReturnTheFlowExecutionsContactOfThisFlowExecution:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Only return the Flow Executions Contact of this Flow Execution
      - in: query
        name: flow_version
        schema:
          type: string
          format: uuid
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: is_active
        schema:
          type: boolean
        description: "A boolean param to filter between active/in progress Flow Execution Contacs.\n\n If the parameter is omitted it will respond with Flow Execution Contacts with any `status`."
        examples:
          OnlyReturnTheFlowExecutionsContactThatAreWithStatus`READY`Or`RUNNING`.:
            value:
            - 'true'
            - any-truthy-value
            - 1
            summary: Only return the Flow Executions Contact that are with status `READY` or `RUNNING`.
          OnlyReturnTheFlowExecutionsContactThatAreWithStatus`CANCELED`Or`COMPLETED`.:
            value:
            - 'false'
            - 0
            summary: Only return the Flow Executions Contact that are with status `CANCELED` or `COMPLETED`.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: search
        schema:
          type: string
        description: You can search with the `contact__phone`, `contact__first_name`, `contact__last_name`, `contact__email` fields.
        examples:
          ByContactEmail:
            value: erik@hilos.io
            summary: by contact email
          ByContactPhone:
            value: '+525512345678'
            summary: by contact phone
          ByContactLastName:
            value: Smith
            summary: by contact last_name
          ByContactFirstName:
            value: Jonh
            summary: by contact first_name
      tags:
      - Flows
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFlowExecutionContactListSimpleList'
          description: ''
  /channel/whatsapp/flow-execution-contact/{id}:
    get:
      operationId: Get Flow Execution Contact
      description: Get Flow Execution Contact by Id.
      summary: Get Flow Execution Contact by Id
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A Flow Execution Contact Id to Retrive.
        required: true
        examples:
          QueryById:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Query by Id
      tags:
      - Flows
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowExecutionContactReadDetail'
          description: ''
  /channel/whatsapp/flow-execution/{id}:
    get:
      operationId: Get Flow Execution
      description: Get Flow Execution by Id.
      summary: Get Flow Execution
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A Flow Execution Id to retrive.
        required: true
        examples:
          QueryById:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Query by Id
      tags:
      - Flows
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowExecutionReadDetail'
          description: ''
  /channel/whatsapp/flow/{id}/run:
    post:
      operationId: Create a Flow Execution
      description: Create a Flow Execution of a Flow.
      summary: Create a Flow Execution
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A Flow Id to create a Flow Execution.
        required: true
        examples:
          CreateByFlowId:
            value: a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1
            summary: Create by Flow Id
      tags:
      - Flows
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowExecutionCreateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FlowExecutionCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FlowExecutionCreateRequest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowExecutionEdit'
          description: ''
components:
  schemas:
    FlowExecutionReadDetail:
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/FlowExecutionStatusEnum'
          readOnly: true
          description: 'The status of the Flow Execution.


            * `PROCESSING` - Processing

            * `READY` - Ready

            * `AWAITING_CONFIRMATION` - Awaiting Confirmation

            * `CONFIRMED` - Confirmed

            * `STARTING` - Starting

            * `RUNNING` - Running

            * `COMPLETED` - Completed

            * `CANCELED` - Canceled'
        execute_for:
          $ref: '#/components/schemas/FlowExecutionExecuteForEnum'
        id:
          type: string
          format: uuid
        has_priority:
          type: boolean
        flow_execution_variables: {}
        start_on:
          type:
          - string
          - 'null'
          format: date-time
        num_contacts:
          type: integer
          maximum: 2147483647
          minimum: 0
        expired:
          type: integer
          maximum: 2147483647
          minimum: 0
        running:
          type: integer
          maximum: 2147483647
          minimum: 0
        completed:
          type: integer
          maximum: 2147483647
          minimum: 0
        canceled:
          type: integer
          maximum: 2147483647
          minimum: 0
        failed:
          type: integer
          maximum: 2147483647
          minimum: 0
        created_on:
          type: string
          format: date-time
          title: Creado el
        avg_completion_time:
          type: string
        status_reason:
          type:
          - string
          - 'null'
          readOnly: true
        status_triggered_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          readOnly: true
        status_last_change_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          description: The User that created the Flow Execution.
        contact_filters:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionContactFilterEdit'
          description: The filters to use to get the Contacts that the Flow Execution will run for. This field isn't required if executing the flow for a Contact List
        contact_import:
          type:
          - string
          - 'null'
          format: uuid
        flow:
          allOf:
          - $ref: '#/components/schemas/FlowSimpleRead'
          description: The Flow that the Flow Execution is running.
        flow_version:
          allOf:
          - $ref: '#/components/schemas/FlowVersionSimpleRead'
          description: The Flow Version that the Flow Execution is running.
        last_run_on:
          type: string
          format: date-time
          readOnly: true
          description: The last time that the Flow Execution was run.
      required:
      - created_by
      - execute_for
      - flow
      - flow_version
      - last_run_on
      - status
      - status_last_change_on
      - status_reason
      - status_triggered_by
    TriggerTypeEnum:
      enum:
      - INBOUND_ANY_MESSAGE
      - INBOUND_SPECIFIC_MESSAGE
      - OUTBOUND_CAMPAIGN_API
      - OUTBOUND_CAMPAIGN_CSV
      - OUTBOUND_CAMPAIGN_SEGMENT
      - OUTBOUND_ANY
      - META_C2WA
      - INTEGRATIONS_HUBSPOT
      - INTEGRATIONS_ZAPIER
      - FROM_FLOW
      - CSAT
      - OTHER
      type: string
      description: '* `INBOUND_ANY_MESSAGE` - Inbound Any Message

        * `INBOUND_SPECIFIC_MESSAGE` - Inbound Specific Message

        * `OUTBOUND_CAMPAIGN_API` - Outbound Campaign Api

        * `OUTBOUND_CAMPAIGN_CSV` - Outbound Campaign Csv

        * `OUTBOUND_CAMPAIGN_SEGMENT` - Outbound Campaign Segment

        * `OUTBOUND_ANY` - Outbound Any

        * `META_C2WA` - Meta C2Wa

        * `INTEGRATIONS_HUBSPOT` - Integrations Hubspot

        * `INTEGRATIONS_ZAPIER` - Integrations Zapier

        * `FROM_FLOW` - From Flow

        * `CSAT` - Csat

        * `OTHER` - Other'
    FlowExecutionContactReadDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        contact:
          allOf:
          - $ref: '#/components/schemas/ContactReadSimple'
          description: The Contact that the Flow Execution Contact is for.
        status:
          $ref: '#/components/schemas/FlowExecutionContactStatusEnum'
        execution_steps:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionStepReadDetail'
          description: The Flow Execution Steps that the Flow Execution Contact has.
        created_on:
          type: string
          format: date-time
          title: Creado el
        flow_execution:
          type:
          - string
          - 'null'
          format: uuid
        status_reason:
          type:
          - string
          - 'null'
          readOnly: true
        flow:
          allOf:
          - $ref: '#/components/schemas/FlowListRead'
          description: Details for the Flow
        flow_version:
          allOf:
          - $ref: '#/components/schemas/FlowVersionSimpleListRead'
          description: Details for the Flow Version
        status_triggered_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          readOnly: true
        status_last_change_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        inbox_contact_id:
          type: string
          format: uuid
          readOnly: true
        is_test:
          type: boolean
      required:
      - contact
      - execution_steps
      - flow
      - flow_version
      - inbox_contact_id
      - status_last_change_on
      - status_reason
      - status_triggered_by
    WhatsAppMessageWithoutContext:
      type: object
      properties:
        id:
          type: string
        to_number:
          type: string
          readOnly: true
        from_number:
          type: string
          readOnly: true
        body:
          type:
          - string
          - 'null'
        direction:
          type: string
        timestamp:
          type: string
          format: date-time
          readOnly: true
        contact:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/MessageStatusEnum'
          readOnly: true
        queued_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        accepted_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        sent_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        delivered_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        read_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        failed_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        provider_id:
          type:
          - string
          - 'null'
          readOnly: true
        provider_error_code:
          type:
          - string
          - 'null'
          readOnly: true
        provider_error_message:
          type:
          - string
          - 'null'
          readOnly: true
        sent_by:
          $ref: '#/components/schemas/SimpleUser'
        is_deleted:
          type: boolean
          readOnly: true
        content:
          readOnly: true
        whatsapp_template:
          $ref: '#/components/schemas/WhatsAppTemplateSimpleRead'
        content_type:
          type:
          - string
          - 'null'
          readOnly: true
        content_url:
          type:
          - string
          - 'null'
          format: uri
          readOnly: true
        msg_type:
          allOf:
          - $ref: '#/components/schemas/MessageTypeEnum'
          readOnly: true
        location:
          $ref: '#/components/schemas/LocationMessage'
        failed_attempts:
          type: integer
          readOnly: true
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ContactMessage'
        source:
          allOf:
          - $ref: '#/components/schemas/MessageSourceEnum'
          readOnly: true
      required:
      - accepted_on
      - contact
      - contacts
      - content
      - content_type
      - content_url
      - delivered_on
      - direction
      - failed_attempts
      - failed_on
      - from_number
      - id
      - is_deleted
      - location
      - msg_type
      - provider_error_code
      - provider_error_message
      - provider_id
      - queued_on
      - read_on
      - sent_by
      - sent_on
      - source
      - status
      - timestamp
      - to_number
      - whatsapp_template
    LanguageEnum:
      enum:
      - af
      - sq
      - ar
      - az
      - bn
      - bg
      - ca
      - zh_CN
      - zh_HK
      - zh_TW
      - hr
      - cs
      - da
      - nl
      - en
      - en_GB
      - en_US
      - et
      - fil
      - fi
      - fr
      - ka
      - de
      - el
      - gu
      - ha
      - he
      - hi
      - hu
      - id
      - ga
      - it
      - ja
      - kn
      - kk
      - rw_RW
      - ko
      - ky_KG
      - lo
      - lv
      - lt
      - mk
      - ms
      - ml
      - mr
      - nb
      - fa
      - pl
      - pt_BR
      - pt_PT
      - pa
      - ro
      - ru
      - sr
      - sk
      - sl
      - es
      - es_AR
      - es_ES
      - es_MX
      - sw
      - sv
      - ta
      - te
      - th
      - tr
      - uk
      - ur
      - uz
      - vi
      - zu
      type: string
      description: '* `af` - Afrikaans

        * `sq` - Albanian

        * `ar` - Arabic

        * `az` - Azerbaijani

        * `bn` - Bengali

        * `bg` - Bulgarian

        * `ca` - Catalan

        * `zh_CN` - Chinese (CHN)

        * `zh_HK` - Chinese (HKG)

        * `zh_TW` - Chinese (TAI)

        * `hr` - Croatian

        * `cs` - Czech

        * `da` - Danish

        * `nl` - Dutch

        * `en` - English

        * `en_GB` - English (UK)

        * `en_US` - English (US)

        * `et` - Estonian

        * `fil` - Filipino

        * `fi` - Finnish

        * `fr` - French

        * `ka` - Georgian

        * `de` - German

        * `el` - Greek

        * `gu` - Gujarati

        * `ha` - Hausa

        * `he` - Hebrew

        * `hi` - Hindi

        * `hu` - Hungarian

        * `id` - Indonesian

        * `ga` - Irish

        * `it` - Italian

        * `ja` - Japanese

        * `kn` - Kannada

        * `kk` - Kazakh

        * `rw_RW` - Kinyarwanda

        * `ko` - Korean

        * `ky_KG` - Kyrgyz (Kyrgyzstan)

        * `lo` - Lao

        * `lv` - Latvian

        * `lt` - Lithuanian

        * `mk` - Macedonian

        * `ms` - Malay

        * `ml` - Malayalam

        * `mr` - Marathi

        * `nb` - Norwegian

        * `fa` - Persian

        * `pl` - Polish

        * `pt_BR` - Portuguese (BR)

        * `pt_PT` - Portuguese (POR)

        * `pa` - Punjabi

        * `ro` - Romanian

        * `ru` - Russian

        * `sr` - Serbian

        * `sk` - Slovak

        * `sl` - Slovenian

        * `es` - Spanish

        * `es_AR` - Spanish (ARG)

        * `es_ES` - Spanish (SPA)

        * `es_MX` - Spanish (MEX)

        * `sw` - Swahili

        * `sv` - Swedish

        * `ta` - Tamil

        * `te` - Telugu

        * `th` - Thai

        * `tr` - Turkish

        * `uk` - Ukrainian

        * `ur` - Urdu

        * `uz` - Uzbek

        * `vi` - Vietnamese

        * `zu` - Zulu'
    FlowStepTimeWindow:
      type: object
      properties:
        weekday:
          allOf:
          - $ref: '#/components/schemas/WeekdayEnum'
          minimum: 0
          maximum: 32767
        is_available:
          type: boolean
        start_at:
          type:
          - string
          - 'null'
          format: time
        end_at:
          type:
          - string
          - 'null'
          format: time
      required:
      - weekday
    FlowExecutionCreateRequestExecuteForEnum:
      enum:
      - LIST
      type: string
      description: '* `LIST` - LIST'
    StepConditionalCondition:
      type: object
      properties:
        field:
          type: string
          maxLength: 255
        comparison:
          $ref: '#/components/schemas/ComparisonEnum'
        value:
          type: string
          maxLength: 255
        id:
          type: integer
          readOnly: true
      required:
      - comparison
      - field
      - id
      - value
    NextActionEnum:
      enum:
      - ANY_RESPONSE
      - BUTTON_RESPONSE
      - CONTINUE
      type: string
      description: '* `ANY_RESPONSE` - Any Response

        * `BUTTON_RESPONSE` - Button Response

        * `CONTINUE` - Continue'
    WhatsAppTemplateStatusEnum:
      enum:
      - draft
      - approved
      - in_appeal
      - pending
      - rejected
      - pending_deletion
      - deleted
      - disabled
      - submitted
      type: string
      description: '* `draft` - Draft

        * `approved` - Approved

        * `in_appeal` - In Appeal

        * `pending` - Pending

        * `rejected` - Rejected

        * `pending_deletion` - Pending Deletion

        * `deleted` - Deleted

        * `disabled` - Disabled

        * `submitted` - Submitted'
    BodyFileTypeEnum:
      enum:
      - URL
      - UPLOAD
      type: string
      description: '* `URL` - Url

        * `UPLOAD` - Upload'
    WeekdayEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: '* `0` - Monday

        * `1` - Tuesday

        * `2` - Wednesday

        * `3` - Thursday

        * `4` - Friday

        * `5` - Saturday

        * `6` - Sunday'
    FlowExecutionStepReadDetailStatusEnum:
      enum:
      - WAITING_TO_START
      - NOT_EXECUTED
      - RUNNING
      - COMPLETED
      - CANCELED
      - FAILED
      - EXPIRED
      type: string
      description: '* `WAITING_TO_START` - Waiting To Start

        * `NOT_EXECUTED` - Not Executed

        * `RUNNING` - Running

        * `COMPLETED` - Completed

        * `CANCELED` - Canceled

        * `FAILED` - Failed

        * `EXPIRED` - Expired'
    FlowExecutionEditSourceEnum:
      enum:
      - HUBSPOT
      - API
      - FRONTEND
      type: string
      description: '* `HUBSPOT` - Hubspot

        * `API` - Api

        * `FRONTEND` - Frontend'
    ComparisonEnum:
      enum:
      - exact
      - '!exact'
      - gte
      - gt
      - lte
      - lt
      - isnull
      - '!isnull'
      - icontains
      - '!icontains'
      type: string
      description: '* `exact` - Exact

        * `!exact` - Different

        * `gte` - Gte

        * `gt` - Gt

        * `lte` - Lte

        * `lt` - Lt

        * `isnull` - Is Null

        * `!isnull` - Not Null

        * `icontains` - Contains

        * `!icontains` - Not Contains'
    FlowVersionSimpleRead:
      type: object
      properties:
        id:
          type: string
          format: uuid
        flow:
          $ref: '#/components/schemas/FlowSimpleRead'
        is_current_version:
          type: boolean
          readOnly: true
        version_name:
          type: string
          maxLength: 255
        version_description:
          type:
          - string
          - 'null'
        published_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          readOnly: true
        created_on:
          type: string
          format: date-time
          title: Creado el
        last_updated_on:
          type: string
          format: date-time
          readOnly: true
          title: Última actualización el
        num_contacts:
          type: integer
          maximum: 2147483647
          minimum: 0
        completed:
          type: integer
          maximum: 2147483647
          minimum: 0
        expired:
          type: integer
          maximum: 2147483647
          minimum: 0
        running:
          type: integer
          maximum: 2147483647
          minimum: 0
        canceled:
          type: integer
          maximum: 2147483647
          minimum: 0
        failed:
          type: integer
          maximum: 2147483647
          minimum: 0
        avg_completion_time:
          type: string
      required:
      - flow
      - is_current_version
      - last_updated_on
      - published_by
    FlowExecutionEdit:
      type: object
      properties:
        status:
          type: string
          readOnly: true
          description: The status of the Flow Execution.
        execute_for:
          $ref: '#/components/schemas/FlowExecutionExecuteForEnum'
        id:
          type: string
          format: uuid
        has_priority:
          type: boolean
        flow_execution_variables: {}
        start_on:
          type:
          - string
          - 'null'
          format: date-time
        num_contacts:
          type: integer
          maximum: 2147483647
          minimum: 0
        expired:
          type: integer
          maximum: 2147483647
          minimum: 0
        running:
          type: integer
          maximum: 2147483647
          minimum: 0
        completed:
          type: integer
          maximum: 2147483647
          minimum: 0
        canceled:
          type: integer
          maximum: 2147483647
          minimum: 0
        failed:
          type: integer
          maximum: 2147483647
          minimum: 0
        created_on:
          type: string
          format: date-time
          title: Creado el
        avg_completion_time:
          type: string
        status_reason:
          type:
          - string
          - 'null'
          readOnly: true
        status_triggered_by:
          type:
          - integer
          - 'null'
          readOnly: true
        status_last_change_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        contact_filters:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionContactFilterEdit'
          description: The filters to use to get the Contacts that the Flow Execution will run for.
        contact_list:
          type: array
          items:
            $ref: '#/components/schemas/PatchedContactEdit'
          description: The list of Contacts that the Flow Execution will run for.
        source:
          $ref: '#/components/schemas/FlowExecutionEditSourceEnum'
        is_hidden:
          type: boolean
      required:
      - execute_for
      - status
      - status_last_change_on
      - status_reason
      - status_triggered_by
    CategoryEnum:
      enum:
      - ACCOUNT_UPDATE
      - PAYMENT_UPDATE
      - PERSONAL_FINANCE_UPDATE
      - SHIPPING_UPDATE
      - RESERVATION_UPDATE
      - ISSUE_RESOLUTION
      - APPOINTMENT_UPDATE
      - TRANSPORTATION_UPDATE
      - TICKET_UPDATE
      - ALERT_UPDATE
      - AUTO_REPLY
      - TRANSACTIONAL
      - MARKETING
      - OTP
      - AUTHENTICATION
      - UTILITY
      type: string
      description: '* `ACCOUNT_UPDATE` - Account Update

        * `PAYMENT_UPDATE` - Payment Update

        * `PERSONAL_FINANCE_UPDATE` - Personal Finance Update

        * `SHIPPING_UPDATE` - Shipping Update

        * `RESERVATION_UPDATE` - Reservation Update

        * `ISSUE_RESOLUTION` - Issue Resolution

        * `APPOINTMENT_UPDATE` - Appointment Update

        * `TRANSPORTATION_UPDATE` - Transportation Update

        * `TICKET_UPDATE` - Ticket Update

        * `ALERT_UPDATE` - Alert Update

        * `AUTO_REPLY` - Auto Reply

        * `TRANSACTIONAL` - Transactional

        * `MARKETING` - Marketing

        * `OTP` - Otp

        * `AUTHENTICATION` - Authentication

        * `UTILITY` - Utility'
    ChannelProviderEnum:
      enum:
      - META_CLOUD_API
      - TECH_PROVIDER_CLOUD_API
      - D360_CLOUD_API
      - 360DIALOG
      type: string
      description: '* `META_CLOUD_API` - Meta Cloud Api

        * `TECH_PROVIDER_CLOUD_API` - Tech Provider Cloud Api

        * `D360_CLOUD_API` - D360 Cloud Api

        * `360DIALOG` - Dialog360'
    AnswerOptionsRenderEnum:
      enum:
      - BUTTONS
      - LIST
      - EMOJIS
      - NUMBERS
      type: string
      description: '* `BUTTONS` - Buttons

        * `LIST` - List

        * `EMOJIS` - Emojis

        * `NUMBERS` - Numbers'
    StepConditionalMultilpePath:
      type: object
      properties:
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/StepConditionalCondition'
      required:
      - conditions
    FlowSimpleRead:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 100
        created_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          readOnly: true
        created_on:
          type: string
          format: date-time
          title: Creado el
        is_active:
          type: boolean
        status:
          $ref: '#/components/schemas/FlowStatusEnum'
        is_legacy:
          type: boolean
        channel:
          allOf:
          - $ref: '#/components/schemas/SimpleChannel'
          readOnly: true
        flow_execution_variables:
          type:
          - array
          - 'null'
          items:
            type: string
            maxLength: 255
        trigger_type:
          $ref: '#/components/schemas/TriggerTypeEnum'
        trigger_config: {}
      required:
      - channel
      - created_by
      - id
      - name
      - trigger_type
    NullEnum:
      enum:
      - null
    MessageStatusEnum:
      enum:
      - new
      - retry
      - accepted
      - sending
      - sent
      - receiving
      - received
      - delivered
      - undelivered
      - failed
      - read
      - deleted
      type: string
      description: '* `new` - New

        * `retry` - Retry

        * `accepted` - Accepted

        * `sending` - Sending

        * `sent` - Sent

        * `receiving` - Receiving

        * `received` - Received

        * `delivered` - Delivered

        * `undelivered` - Undelivered

        * `failed` - Failed

        * `read` - Read

        * `deleted` - Deleted'
    WhatsAppMessage:
      type: object
      properties:
        id:
          type: string
        to_number:
          type: string
          readOnly: true
        from_number:
          type: string
          readOnly: true
        body:
          type:
          - string
          - 'null'
        direction:
          type: string
        timestamp:
          type: string
          format: date-time
          readOnly: true
        contact:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-flows-api-openapi.yml