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/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
        context_message:
          allOf:
          - $ref: '#/components/schemas/WhatsAppMessageWithoutContext'
          readOnly: true
      required:
      - accepted_on
      - contact
      - contacts
      - content
      - content_type
      - content_url
      - context_message
      - 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
    FlowExecutionList:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/FlowExecutionStatusEnum'
        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'
        status_triggered_by:
          type:
          - integer
          - 'null'
        status_last_change_on:
          type:
          - string
          - 'null'
          format: date-time
        created_by:
          allOf:
          - $ref: '#/components/schemas/SimpleUser'
          description: The User that created the Flow Execution.
        flow_version:
          type: string
          format: uuid
      required:
      - created_by
      - execute_for
      - flow_version
    FlowExecutionContactStatusEnum:
      enum:
      - READY
      - RUNNING
      - COMPLETED
      - CANCELED
      - EXPIRED
      - FAILED
      type: string
      description: '* `READY` - Ready

        * `RUNNING` - Running

        * `COMPLETED` - Completed

        * `CANCELED` - Canceled

        * `EXPIRED` - Expired

        * `FAILED` - Failed'
    FlowExecutionStatusEnum:
      enum:
      - PROCESSING
      - READY
      - AWAITING_CONFIRMATION
      - CONFIRMED
      - STARTING
      - RUNNING
      - COMPLETED
      - CANCELED
      type: string
      description: '* `PROCESSING` - Processing

        * `READY` - Ready

        * `AWAITING_CONFIRMATION` - Awaiting Confirmation

        * `CONFIRMED` - Confirmed

        * `STARTING` - Starting

        * `RUNNING` - Running

        * `COMPLETED` - Completed

        * `CANCELED` - Canceled'
    FlowStatusEnum:
      enum:
      - DRAFT
      - PUBLISHED
      type: string
      description: '* `DRAFT` - Draft

        * `PUBLISHED` - Published'
    FlowVersionSimpleListRead:
      type: object
      properties:
        id:
          type: string
          format: uuid
        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
        is_current_version:
          type: boolean
          readOnly: true
      required:
      - is_current_version
      - last_updated_on
      - published_by
    AnswerTypeEnum:
      enum:
      - ANY
      - FREE_TEXT
      - SINGLE_OPTION
      - NUMBER
      - URL
      - EMAIL
      - FILE
      - DOCUMENT
      - VIDEO
      - IMAGE
      - PHONE
      - DATE
      - TIME
      - DATETIME
      - BOOL
      - LOCATION
      type: string
      description: '* `ANY` - Any

        * `FREE_TEXT` - Free Text

        * `SINGLE_OPTION` - Single Option

        * `NUMBER` - Number

        * `URL` - Url

        * `EMAIL` - Email

        * `FILE` - File

        * `DOCUMENT` - Document

        * `VIDEO` - Video

        * `IMAGE` - Image

        * `PHONE` - Phone

        * `DATE` - Date

        * `TIME` - Time

        * `DATETIME` - Datetime

        * `BOOL` - Bool

        * `LOCATION` - Location'
    ChannelTypeEnum:
      enum:
      - WHATSAPP
      - EMAIL
      - INSTAGRAM
      - FB_MESSENGER
      - TELEGRAM
      - SMS
      - VOICE
      type: string
      description: '* `WHATSAPP` - Whatsapp

        * `EMAIL` - Email

        * `INSTAGRAM` - Instagram

        * `FB_MESSENGER` - Fb Messenger

        * `TELEGRAM` - Telegram

        * `SMS` - Sms

        * `VOICE` - Voice'
    FlowExecutionCreateRequest:
      type: object
      properties:
        execute_for:
          $ref: '#/components/schemas/FlowExecutionCreateRequestExecuteForEnum'
        has_priority:
          type: boolean
          default: false
          description: Specify as True if you want this execution to                 close any other running flows or conversations.
        contact_list:
          type: array
          items:
            $ref: '#/components/schemas/PatchedContactEdit'
      required:
      - contact_list
      - execute_for
    ContactNote:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        notes:
          type: string
        contact:
          type: string
          format: uuid
          readOnly: true
        created_on:
          type: string
          format: date-time
          readOnly: true
          title: Creado el
        created_by:
          $ref: '#/components/schemas/SimpleUser'
      required:
      - contact
      - created_on
      - id
      - notes
    FlowExecutionExecuteForEnum:
      enum:
      - FILTERS
      - LIST
      - ALL
      type: string
      description: '* `FILTERS` - Filters

        * `LIST` - List

        * `ALL` - All'
    ContactMessage:
      type: object
      properties:
        addresses:
          type: array
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        emails:
          type: array
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        ims:
          type: array
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        urls:
          type: array
          items:
            type: string
            maxLength: 255
        name:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
        phones:
          type: array
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        org:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
    WhatsAppTemplateSimpleRead:
      type: object
      properties:
        name:
          type: string
          maxLength: 120
        language:
          $ref: '#/components/schemas/LanguageEnum'
        components: {}
        id:
          type: string
          format: uuid
          readOnly: true
          description: The UUID of the WhatsApp Template to be sent.
        category:
          $ref: '#/components/schemas/CategoryEnum'
        status:
          $ref: '#/components/schemas/WhatsAppTemplateStatusEnum'
        rejected_reason:
          type:
          - string
          - 'null'
        is_deleted:
          type: boolean
        channel:
          allOf:
          - $ref: '#/components/schemas/SimpleChannel'
          description: The ID of the WhatsApp Channel that the WhatsApp Template is for.
        show_in_sandbox:
          type: boolean
      required:
      - category
      - channel
      - id
      - language
      - name
    MaxWaitTimeUnitEnum:
      enum:
      - SECOND
      - MINUTE
      - HOUR
      - DAY
      type: string
      description: '* `SECOND` - Second

        * `MINUTE` - Minute

        * `HOUR` - Hour

        * `DAY` - Day'
    ActionRequestMethodEnum:
      enum:
      - GET
      - POST
      - PUT
      - PATCH
      - DELETE
      type: string
      description: '* `GET` - Get

        * `POST` - Post

        * `PUT` - Put

        * `PATCH` - Patch

        * `DELETE` - Delete'
    FlowListRead:
      type: object
      properties:
        id:
          type: string
          format: uuid
          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
        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
        needs_update:
          type: boolean
        avg_completion_time:
          type: string
        current_version:
          type:
          - string
          - 'null'
          format: uuid
        is_template:
          type: boolean
        trigger_type:
          $ref: '#/components/schemas/TriggerTypeEnum'
        trigger_config: {}
        test_version:
          type:
          - string
          - 'null'
          format: uuid
        upgrade_version:
          type:
          - string
          - 'null'
          format: uuid
        legacy_version:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - channel
      - created_by
      - id
      - name
      - trigger_type
    PaginatedFlowExecutionListList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionList'
    FlowExecutionContactListSimple:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        contact:
          allOf:
          - $ref: '#/components/schemas/ContactReadSimple'
          description: The Contact that the Flow Execution Contact is for.
        status:
          $ref: '#/components/schemas/FlowExecutionContactStatusEnum'
        created_on:
          type: string
          format: date-time
          title: Creado el
        status_reason:
          type:
          - string
          - 'null'
          readOnly: true
        is_test:
          type: boolean
        flow_version:
          type:
          - string
          - 'null'
          format: uuid
        flow:
          type:
          - string
          - 'null'
          format: uuid
        flow_name:
          type: string
          readOnly: true
          description: The name of the Flow that the Flow Execution Contact is for.
      required:
      - contact
      - flow_name
      - id
      - status_reason
    LocationMessage:
      type: object
      properties:
        address:
          type: string
          maxLength: 500
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        place_name:
          type:
          - string
          - 'null'
          maxLength: 500
        place_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 200
        map_screenshot_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 200
      required:
      - address
      - latitude
      - longitude
    FlowExecutionStepWhatsAppMessage:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/WhatsAppMessage'
      required:
      - message
    BlankEnum:
      enum:
      - ''
    PaginatedFlowExecutionContactListSimpleList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionContactListSimple'
    MessageSourceEnum:
      enum:
      - INBOUND
      - INBOX
      - AUTO_RESPONSE
      - API
      - BROADCAST
      - FLOW
      type: string
      description: '* `INBOUND` - Inbound

        * `INBOX` - Inbox

        * `AUTO_RESPONSE` - Auto Response

        * `API` - Api

        * `BROADCAST` - Broadcast

        * `FLOW` - Flow'
    FlowStepContactUpdateCustomProperty:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
      required:
      - key
      - value
    ChannelStatusEnum:
      enum:
      - NEW
      - ACTIVE
      - INACTIVE
      type: string
      description: '* `NEW` - New

        * `ACTIVE` - Active

        * `INACTIVE` - Inactive'
    FlowStepEdit:
      type: object
      description: This class is not useful other than for the OpenAPI Schema.
      properties:
        flow_version:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 100
        step_type:
          type: string
          maxLength: 100
        next_step_default_idx:
          type:
          - integer
          - 'null'
          maximum: 32767
          minimum: 0
        id:
          type: string
          format: uuid
        next_step_default:
          type: string
          format: uuid
        next_step_alternate:
          type: string
          format: uuid
        answer_failed_next_step:
          type:
          - string
          - 'null'
          format: uuid
        next_steps_for_options:
          type: array
          items:
            type: string
            format: uuid
        answer_type:
          oneOf:
          - $ref: '#/components/schemas/AnswerTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        body:
          type:
          - string
          - 'null'
        body_type:
          oneOf:
          - $ref: '#/components/schemas/MessageTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        body_file_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2000
        body_file_type:
          oneOf:
          - $ref: '#/components/schemas/BodyFileTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        body_file:
          allOf:
          - $ref: '#/components/schemas/UploadedAccountFile'
          readOnly: true
        answer_validation_message:
          type:
          - string
          - 'null'
        answer_instructions:
          type:
          - string
          - 'null'
        answer_options:
          type:
          - array
          - 'null'
          items:
            type: string
            maxLength: 255
        answer_phone_default_country:
          oneOf:
          - $ref: '#/components/schemas/AnswerPhoneDefaultCountryEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        next_step_alternate_idx:
          type:
          - integer
          - 'null'
          maximum: 32767
          minimum: 0
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/StepConditionalCondition'
        delay_type:
          type:
          - string
          - 'null'
          maxLength: 20
        delay_until:
          type:
          - string
          - 'null'
          format: date-time
        action_request_method:
          oneOf:
          - $ref: '#/components/schemas/ActionRequestMethodEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        action_request_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2000
        action_request_headers:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        action_request_params:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        action_request_body:
          type:
          - string
          - 'null'
        action_test_response_data:
          type:
          - string
          - 'null'
          format: uuid
        answer_allow_decimals:
          type: boolean
        answer_range_min:
          type:
          - string
          - 'null'
          maxLength: 50
        answer_range_max:
          type:
          - string
          - 'null'
          maxLength: 50
        answer_has_range:
          type: boolean
        assign_to_users:
          type: array
          items:
            type: integer
          readOnly: true
        ordering_idx:
          type: integer
          maximum: 32767
          minimum: 0
        has_options_from_variable:
          type: boolean
        option_from_variable_value:
          type:
          - string
          - 'null'
        options_from_variable:
          type:
          - string
          - 'null'
        option_from_variable_title:
          type:
          - string
          - 'null'
        option_from_variable_description:
          type:
          - string
          - 'null'
        missing_options_message:
          type:
          - string
          - 'null'
        answer_options_render:
          $ref: '#/components/schemas/AnswerOptionsRenderEnum'
        answer_options_render_list_button_title:
          type:
          - string
          - 'null'
          maxLength: 20
        answer_option_descriptions:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        next_steps_for_options_idx:
          type:
          - array
          - 'null'
          items:
            type:
            - integer
            - 'null'
            maximum: 2147483647
            minimum: -2147483648
        contact_tags:
          type:
          - array
          - 'null'
          items:
            type: string
            maxLength: 255
        conversation_tags:
          type:
          - array
          - 'null'
          items:
            type: string
            maxLength: 255
        append_tags:
          type: boolean
        max_wait_time_amount:
          type: integer
          maximum: 32767
          minimum: 0
        max_wait_time_unit:
          $ref: '#/components/schemas/MaxWaitTimeUnitEnum'
        time_windows:
          type: array
          items:
            $ref: '#/components/schemas/FlowStepTimeWindow'
        has_max_wait_time:
          type: boolean
        set_time_window:
          type: boolean
        assign_to_teams:
          type: array
          items:
            type: integer
          readOnly: true
        time_window_type:
          oneOf:
          - $ref: '#/components/schemas/TimeWindowTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        has_max_answer_attempts:
          type: boolean
        max_answer_attempts:
          type: integer
          maximum: 32767
          minimum: 0
        answer_failed_next_step_idx:
          type:
          - integer
          - 'null'
          maximum: 32767
          minimum: 0
        whatsapp_template:
          type: string
          format: uuid
          readOnly: true
        whatsapp_template_variables:
          readOnly: true
        save_contact_answer:
          type: boolean
          default: false
        validate_answer_with_buttons:
          type: boolean
          default: false
        contact_custom_properties:
          type: array
          items:
            $ref: '#/components/schemas/FlowStepContactUpdateCustomProperty'
        contact_first_name:
          type: string
        contact_last_name:
          type: string
        contact_email:
          type: string
        contact_external_url:
          type: string
        next_flow:
          type: string
        paths:
          type: array
          items:
            $ref: '#/components/schemas/StepConditionalMultilpePath'
        firstname:
          type: string
        lastname:
          type: string
        email:
          type: string
        custom_properties:
          type: array
          items:
            type: string
        next_action:
          $ref: '#/components/schemas/NextActionEnum'
      required:
      - assign_to_teams
      - assign_to_users
      - body_file
      - conditions
      - flow_version
      - name
      - next_steps_for_options
      - step_type
      - time_windows
      - whatsapp_template
      - whatsapp_template_variables
    MessageTypeEnum:
      enum:
      - audio
      - voice
      - button
      - document
      - text
      - image
      - interactive
      - order
      - sticker
      - system
      - unknown
      - video
      - unsupported
      - location
      - contacts
      - template
      - reaction
      - ephemeral
      - request_welcome
      type: string
      description: '* `audio` - Audio

        * `voice` - Voice

        * `button` - Button

        * `document` - Document

        * `text` - Text

        * `image` - Image

        * `interactive` - Interactive

        * `order` - Order

        * `sticker` - Sticker

        * `system` - System

        * `unknown` - Unknown

        * `video` - Video

        * `unsupported` - Unsupported

        * `location` - Location

        * `contacts` - Contacts

        * `template` - Template

        * `reaction` - Reaction

        * `ephemeral` - Ephemeral

        * `request_welcome` - Request Welcome'
    FlowExecutionStepReadDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        step:
          allOf:
          - $ref: '#/components/schemas/FlowStepEdit'
          readOnly: true
        status_reason:
          type:
          - string
          - 'null'
        has_error:
          type: boolean
        expire_on:
          type:
          - string
          - 'null'
          format: date-time
        status:
          $ref: '#/components/schemas/FlowExecutionStepReadDetailStatusEnum'
        validation_failed_attempts:
          type: integer
          maximum: 32767
          minimum: 0
        execution_result: {}
        request_data: {}
        messages:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionStepWhatsAppMessage'
        created_on:
          type: string
          format: date-time
          title: Creado el
        status_triggered_by:
          type:
          - integer
          - 'null'
        status_last_change_on:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - messages
      - step
    FlowExecutionContactFilterEdit:
      type: object
      properties:
        field:
          type: string
        comparison:
          $ref: '#/components/schemas/ComparisonEnum'
        value:
          type: string
        id:
          type: string
          format: uuid
      required:
      - comparison
      - field
      - value
    TimeWindowTypeEnum:
      enum:
      - IN_WORKING_HOURS
      - CUSTOM
      type: string
      description: '* `IN_WORKING_HOURS` - In Working Hours

        * `CUSTOM` - Custom'
    SimpleUser:
      type: object
      properties:
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          maxLength: 254
        id:
          type: integer
          readOnly: true
        profile_image:
          type:
          - string
          - 'null'
          format: uri
        role:
          type:
          - integer
          - 'null'
      required:
      - email
      - id
    AnswerPhoneDefaultCountryEnum:
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BQ
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - CV
      - KH
      - CM
      - CA
      - KY
      - CF
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CW
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - KP
      - MK
      - MP
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - BL
      - SH
      - KN
      - LC
      - MF
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SX
      - SK
      - SI
      - SB
      - SO
      - ZA
      - GS
      - KR
      - SS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - UM
      - US
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      type: string
      description: '* `AF` - Afghanistan

        * `AX` - Åland Islands

        * `AL` - Albania

        * `DZ` - Algeria

        * `AS` - American Samoa

        * `AD` - Andorra

        * `AO` - Angola

        * `AI` - Anguilla

        * `AQ` - Antarctica

        * `AG` - Antigua and Barbuda

        * `AR` - Argentina

        * `AM` - Armenia

        * `AW` - Aruba

        * `AU` - Australia

        * `AT` - Austria

        * `AZ` - Azerbaijan

        * `BS` - Bahamas

        * `BH` - Bahrain

        * `BD` - Bangladesh

        * `BB` - Barbados

        * `BY` - Belarus

        * `BE` - Belgium

        * `BZ` - Belize

        * `BJ` - Benin

        * `BM` - Bermuda

        * `BT` - Bhutan

        * `BO` - Bolivia

        * `BQ` - Bonaire, Sint Eustatius and Saba

        * `BA` - Bosnia and Herzegovina

        * `BW` - Botswana

        * `BV` - Bouvet Island

        * `BR` - Brazil

        * `IO` - British Indian Ocean Territory

        * `BN` - Brunei

        * `BG` - Bulgaria

        * `BF` - Burkina Faso

        * `BI` - Burundi

        * `CV` - Cabo Verde

        * `KH` - Cambodia

        * `CM` - Cameroon

        * `CA` - Canada

        * `KY` - Cayman Islands

        * `CF` - Central African Republic

        * `TD` - Chad

        * `CL` - Chile

        * `CN` - China

        * `CX` - Christmas Island

        * `CC` - Cocos (Keeling) Islands

        * `CO` - Colombia

        * `KM` - Comoros

        * `CG` - Congo

        * `CD` - Congo (the Democratic Republic of the)

        * `CK` - Cook Islands

        * `CR` - Costa Rica

        * `CI` - Côte d''Ivoire

        * `HR` - Croatia

        * `CU` - Cuba

        * `CW` - Curaçao

        * `CY` - Cyprus

        * `CZ` - Czechia

        * `DK` - Denmark

        * `DJ` - Djibouti

        * `DM` - Dominica

        * `DO` - Dominican Republic

        * `EC` - Ecuador

        * `EG` - Egypt

        * `SV` - El Salvador

        * `GQ` - Equatorial Guinea

        * `ER` - Eritrea

        * `EE` - Estonia

        * `SZ` - Eswatini

        * `ET` - Ethiopia

        * `FK` - Falkland Islands (Malvinas)

        * `FO` - Faroe Islands

        * `FJ` - Fiji

        * `FI` - Finland

        * `FR` - France

        * `GF` - French Guiana

        * `PF` - French Polynesia

        * `TF` - French Southern Territories

        * `GA` - Gabon

        * `GM` - Gambia

        * `GE` - Georgia

        * `DE` - Germany

        * `GH` - Ghana

        * `GI` - Gibraltar

        * `GR` - Greece

        * `GL` - Greenland

        * `GD` - Grenada

        * `GP` - Guadeloupe

        * `GU` - Guam

        * `GT` - Guatemala

        * `GG` - Guernsey

        * `GN` - Guinea

        * `GW` - Guinea-Bissau

        * `GY` - Guyana

        * `HT` - Haiti

        * `HM` - Heard Island and McDonald Islands

        * `VA` - Holy See

        * `HN` - Honduras

        * `HK` - Hong Kong

        * `HU` - Hungary

        * `IS` - Iceland

        * `IN` - India

        * `ID` - Indonesia

        * `IR` - Iran

        * `IQ` - Iraq

        * `IE` - Ireland

        * `IM` - Isle of Man

        * `IL` - Israel

        * `IT` - Italy

        * `JM` - Jamaica

        * `JP` - Japan

        * `JE` - Jersey

        * `JO` - Jordan

        * `KZ` - Kazakhstan

        * `KE` - Kenya

        * `KI` - Kiribati

        * `KW` - Kuwait

        * `KG` - Kyrgyzstan

        * `LA` - Laos

        * `LV` - Latvia

        * `LB` - Lebanon

        * `LS` - Lesotho

        * `LR` - Liberia

        * `LY` - Libya

        * `LI` - Liechtenstein

        * `LT` - Lithuania

        * `LU` - Luxembourg

        * `MO` - Macao

        * `MG` - Madagascar

        * `MW` - Malawi

        * `MY` - Malaysia

        * `MV` - Maldives

        * `ML` - Mali

        * `MT` - Malta

        * `MH` - Marshall Islands

        * `MQ` - Martinique

        * `MR` - Mauritania

        * `MU` - Mauritius

        * `YT` - Mayotte

        * `MX` - Mexico

        * `FM` - Micronesia

        * `MD` - Moldova

        * `MC` - Monaco

        * `MN` - Mongolia

        * `ME` - Montenegro

        * `MS` - Montserrat

        * `MA` - Morocco

        * `MZ` - Mozambique

        * `MM` - Myanmar

        * `NA` - Namibia

        * `NR` - Nauru

        * `NP` - Nepal

        * `NL` - Netherlands

        * `NC` - New Caledonia

        * `NZ` - New Zealand

        * `NI` - Nicaragua

        * `NE` - Niger

        * `NG` - Nigeria

        * `NU` - Niue

        * `NF` - Norfolk Island

        * `KP` - North Korea

        * `MK` - North Macedonia

        * `MP` - Northern Mariana Islands

        * `NO` - Norway

        * `OM` - Oman

        * `PK` - Pakistan

        * `PW` - Palau

        * `PS` - Palestine, State of

        * `PA` - Panama

        * `PG` - Papua New Guinea

        * `PY` - Paraguay

        * `PE` - Peru

        * `PH` - Philippines

        * `PN` - Pitcairn

        * `PL` - Poland

        * `PT` - Portugal

        * `PR` - Puerto Rico

        * `QA` - Qatar

        * `RE` - Réunion

        * `RO` - Romania

        * `RU` - Russia

        * `RW` - Rwanda

        * `BL` - Saint Barthélemy

        * `SH` - Saint Helena, Ascension and Tristan da Cunha

        * `KN` - Saint Kitts and Nevis

        * `LC` - Saint Lucia

        * `MF` - Saint Martin (French part)

        * `PM` - Saint Pierre and Miquelon

        * `VC` - Saint Vincent and the Grenadines

        * `WS` - Samoa

        * `SM` - San Marino

        * `ST` - Sao Tome and Principe

        * `SA` - Saudi Arabia

        * `SN` - Senegal

        * `RS` - Serbia

        * `SC` - Seychelles

        * `SL` - Sierra Leone

        * `SG` - Singapore

        * `SX` - Sint Maarten (Dutch part)

        * `SK` - Slovakia

        * `SI` - Slovenia

        * `SB` - Solomon Islands

        * `SO` - Somalia

        * `ZA` - South Africa

        * `GS` - South Georgia and the South Sandwich Islands

        * `KR` - South Korea

        * `SS` - South Sudan

        * `ES` - Spain

        * `LK` - Sri Lanka

        * `SD` - Sudan

        * `SR` - Suriname

        * `SJ` - Svalbard and Jan Mayen

        * `SE` - Sweden

        * `CH` - Switzerland

        * `SY` - Syria

        * `TW` - Taiwan

        * `TJ` - Tajikistan

        * `TZ` - Tanzania

        * `TH` - Thailand

        * `TL` - Timor-Leste

        * `TG` - Togo

        * `TK` - Tokelau

        * `TO` - Tonga

        * `TT` - Trinidad and Tobago

        * `TN` - Tunisia

        * `TR` - Türkiye

        * `TM` - Turkmenistan

        * `TC` - Turks and Caicos Islands

        * `TV` - Tuvalu

        * `UG` - Uganda

        * `UA` - Ukraine

        * `AE` - United Arab Emirates

        * `GB` - United Kingdom

        * `UM` - United States Minor Outlying Islands

        * `US` - United States of America

        * `UY` - Uruguay

        * `UZ` - Uzbekistan

        * `VU` - Vanuatu

        * `VE` - Venezuela

        * `VN` - Vietnam

        * `VG` - Virgin Islands (British)

        * `VI` - Virgin Islands (U.S.)

        * `WF` - Wallis and Futuna

        * `EH` - Western Sahara

        * `YE` - Yemen

        * `ZM` - Zambia

        * `ZW` - Zimbabwe'
    UploadedAccountFile:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        uploaded_file:
          type: string
          format: uri
        content_type:
          type: string
        original_name:
          type:
          - string
          - 'null'
          maxLength: 255
      required:
      - id
      - uploaded_file
      - url
    ContactTag:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 100
      required:
      - id
      - name
    ContactReadSimple:
      type: object
      properties:
        first_name:
          type:
          - string
          - 'null'
          maxLength: 100
        last_name:
          type:
          - string
          - 'null'
          maxLength: 100
        email:
          type:
          - string
          - 'null'
          format: email
          maxLength: 254
        meta: {}
        canonical_phone:
          type:
          - string
          - 'null'
          maxLength: 30
        is_deleted:
          type: boolean
        phone:
          type: string
        id:
          type: string
        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
        source:
          type: string
          maxLength: 255
        external_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 200
      required:
      - id
      - last_updated_on
      - phone
      - source
    PatchedContactEdit:
      type: object
      properties:
        phone:
          type: string
          maxLength: 30
        first_name:
          type:
          - string
          - 'null'
          maxLength: 100
        last_name:
          type:
          - string
          - 'null'
          maxLength: 100
        email:
          type:
          - string
          - 'null'
          format: email
          maxLength: 254
        meta: {}
        external_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 200
        is_deleted:
          type: boolean
        id:
          type: string
          format: uuid
        source:
          type: string
          default: website
        notes:
          type: array
          items:
            $ref: '#/components/schemas/ContactNote'
          readOnly: true
        created_on:
          type: string
          format: date-time
          title: Creado el
        tags:
          type: array
          items:
            $ref: '#/components/schemas/ContactTag'
        external_id:
          type:
          - string
          - 'null'
        native_id:
          type:
          - string
          - 'null'
        default_assignees:
          type: array
          items:
            type: integer
        contact_import:
          type:
          - string
          - 'null'
          format: uuid
        default_channel:
          type:
          - integer
          - 'null'
        wa_id:
          type:
          - string
          - 'null'
        overwrite_tags:
          type: boolean
          default: false
          description: 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:
          type: boolean
          default: false
          description: 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:
          type: boolean
          default: false
          description: 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.
    SimpleChannel:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        channel_type:
          $ref: '#/components/schemas/ChannelTypeEnum'
        name:
          type: string
          maxLength: 100
        channel_id:
          type: string
          maxLength: 100
        status:
          $ref: '#/components/schemas/ChannelStatusEnum'
        created_on:
          type: string
          format: date-time
          title: Creado el
        channel_provider:
          $ref: '#/components/schemas/ChannelProviderEnum'
        is_sandbox:
          type: boolean
      required:
      - channel_id
      - id
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Token
      description: Token-based authentication with required prefix "Token"
x-tagGroups:
- name: Users
  tags:
  - User
- name: Channels
  tags:
  - WhatsApp
  - Broadcast
- name: Flows
  tags:
  - Flow Execution
  - Flow Execution Contact
- name: CRM
  tags:
  - Contact
  - Conversation
- name: Integrations
  tags:
  - Webhook Subscription