> ## Documentation Index
> Fetch the complete documentation index at: https://developers.wachat.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Enroll contact in flow

> Enrolls a contact into an automation flow using a contact ID or phone number. Enrollment is idempotent, so retrying the same request does not create duplicate subscriptions.



## OpenAPI

````yaml /openapi.json post /flows/{id}/enroll
openapi: 3.1.0
info:
  title: Wachat API
  version: v1
  description: >-
    Wachat REST API. Authenticate with a workspace API key: send it as
    `Authorization: Bearer <key>`. Generate keys in the dashboard under
    Developers / API.
servers:
  - url: https://crm.wachat.net/api/v1
security:
  - http: []
tags:
  - name: Message
    description: >-
      Send a single WhatsApp message — text, media (image / video / document /
      audio) or a location pin — to one number, then read its delivery status or
      your message history. A file can be attached directly as a multipart
      `media` field or referenced by a public URL.
  - name: Template
    description: >-
      Create, list and manage your approved WhatsApp templates, and send a
      template to one number with your own header, body variables and button
      values. Use this for utility / marketing sends that need a pre-approved
      template — including one with a PDF / document header (pass the file's
      public URL as the header, e.g. from the Media endpoint).
  - name: Media
    description: >-
      Upload a file once (multipart / form-data, field name `file`, up to 16 MB)
      and get back a hosted public URL you can reuse across sends — for example
      a PDF to use as a document-header on a template, or an image on a message.
  - name: Contact
    description: >-
      Full create / read / update / delete over your contacts and leads,
      including search by number, tags and custom attributes.
  - name: ContactGroup
    description: >-
      Organise contacts into groups: create groups, list them, and add or remove
      members — handy for targeting broadcasts and campaigns.
  - name: Broadcast
    description: >-
      Send the same message to many contacts at once and track each broadcast's
      progress and per-recipient delivery.
  - name: Campaign
    description: >-
      Create, start, pause and monitor drip / marketing campaigns and their
      recipients.
  - name: Scheduled
    description: >-
      Schedule a WhatsApp send for a future time, list upcoming scheduled
      messages, and cancel one before it goes out.
  - name: AutoReply
    description: >-
      Manage keyword auto-replies — the automatic responses that fire when an
      inbound message matches a rule.
  - name: Flow
    description: >-
      Enroll a contact into an automation flow (chatbot) and manage your flows
      through the API.
  - name: Device
    description: >-
      List the WhatsApp numbers / devices connected to your workspace and check
      each one's connection status.
  - name: Webhook
    description: >-
      Register and manage webhook endpoints so Wachat POSTs real-time events
      (message received / sent / delivered / read / failed, plus campaign and
      contact events) to your server. When you set a signing secret each
      delivery carries an HMAC-SHA256 signature header you can verify.
  - name: Deal
    description: >-
      Manage sales-pipeline deals — create, list, update and move deals between
      stages.
  - name: Conversation
    description: >-
      Read your workspace inbox: list chat threads (conversations) and fetch the
      messages inside a thread.
  - name: Account
    description: Read your account details, plan, limits and message-credit usage.
paths:
  /flows/{id}/enroll:
    post:
      tags:
        - Flow
      summary: Enroll contact in flow
      description: >-
        Enrolls a contact into an automation flow using a contact ID or phone
        number. Enrollment is idempotent, so retrying the same request does not
        create duplicate subscriptions.
      operationId: v1.flows.enroll
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollFlowRequest'
      responses:
        '201':
          description: Resource created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      flow_id:
                        type: string
                      contact_id:
                        type: integer
                      subscriber_id:
                        type: string
                      status:
                        type: string
                      enrolled_at:
                        type: string
                    required:
                      - flow_id
                      - contact_id
                      - subscriber_id
                      - status
                      - enrolled_at
                  meta:
                    type: string
                required:
                  - data
                  - meta
        '404':
          description: Request failed.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            const: contact_not_found
                          message:
                            type: string
                            const: >-
                              No contact matches that id or phone in this
                              workspace.
                          details:
                            type: string
                        required:
                          - code
                          - message
                          - details
                    required:
                      - error
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            const: not_found
                          message:
                            type: string
                            const: Flow not found.
                          details:
                            type: string
                        required:
                          - code
                          - message
                          - details
                    required:
                      - error
        '422':
          $ref: '#/components/responses/ValidationException'
          description: Request failed.
components:
  schemas:
    EnrollFlowRequest:
      type: object
      description: >-
        Enroll a contact into a flow. Scramble reads these rules to document the

        request body. Identify the contact by `contact_id` (a contact already in

        the workspace) OR by `phone` (the contact is looked up by its E.164

        number). Exactly one is required; the controller resolves it to a
        Contact

        and hands it to FlowEnrollmentService::enroll().
      properties:
        contact_id:
          type:
            - integer
            - 'null'
          description: >-
            Id of an existing contact in the workspace. Required unless `phone`
            is given.
        phone:
          type:
            - string
            - 'null'
          description: >-
            Contact phone in international format (digits, E.164). Used to look
            up

            the contact when `contact_id` is omitted. Required unless
            `contact_id` is given.
          maxLength: 32
      title: EnrollFlowRequest
  responses:
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    http:
      type: http
      scheme: bearer

````