FUSE Health CRM · Sequences API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) CRM · Sequences API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: CRM · Sequences
paths:
  /api/v1/sequences:
    get:
      tags:
      - CRM · Sequences
      summary: List sequences
      operationId: getApiV1Sequences
      description: List sequences.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Sequence'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      tags:
      - CRM · Sequences
      summary: Create a sequence (draft). Key-created rows store createdBy=null (audited)
      operationId: postApiV1Sequences
      description: Create a sequence (draft). Key-created rows store createdBy=null (audited).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                triggerEvent:
                  type: string
            example:
              name: Welcome series
              triggerEvent: manual
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Sequence'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/sequences/{id}:
    get:
      tags:
      - CRM · Sequences
      summary: Sequence detail + analytics
      operationId: getApiV1SequencesById
      description: Sequence detail + analytics.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Sequence'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      tags:
      - CRM · Sequences
      summary: Update a sequence
      operationId: putApiV1SequencesById
      description: Update a sequence.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
            example:
              name: Renamed
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Sequence'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/sequences/{id}/steps:
    put:
      tags:
      - CRM · Sequences
      summary: Replace a sequence's steps
      operationId: putApiV1SequencesByIdSteps
      description: Replace a sequence's steps.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                steps:
                  type: array
                  items: {}
            example:
              steps: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/sequence-triggers/manual:
    post:
      tags:
      - CRM · Sequences
      summary: Manually trigger an active sequence for a user or a tag (provide exactly one)
      operationId: postApiV1SequencetriggersManual
      description: Manually trigger an active sequence for a user or a tag (provide exactly one).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sequenceId:
                  type: string
                userId:
                  type: string
            example:
              sequenceId: <seq-uuid>
              userId: <patient-uuid>
      responses:
        '201':
          description: 'Runs started. Only contacts who can receive at least one of the sequence''s message channels get a run: email steps need `notifyProductNews`, SMS steps need `notifySmsUpdates`, and an unsubscribed contact gets neither. Tag sends report who was skipped in `data.skipped`. A started contact who loses a channel (for example texts go, emails don''t) is listed in `data.skippedChannels` (single contact) or `data.partiallySkipped` (tag).'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      sequenceId:
                        type: string
                      sequenceRunId:
                        type: string
                      sequenceRunIds:
                        type: array
                        items:
                          type: string
                      usersTriggered:
                        type: integer
                      usersSkipped:
                        type: integer
                      skippedChannels:
                        type: array
                        items:
                          $ref: '#/components/schemas/SequenceSkipReason'
                      skipped:
                        type: array
                        items:
                          $ref: '#/components/schemas/SequenceSkip'
                      partiallySkipped:
                        type: array
                        items:
                          $ref: '#/components/schemas/SequenceSkip'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: 'Nothing was sent: no target contact can receive the sequence (`code: CONTACT_NOT_REACHABLE`). For a contact who hasn''t opted in to marketing email, record consent with PUT /api/v1/contacts/{id}/marketing-consent.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  code:
                    type: string
                    enum:
                    - CONTACT_NOT_REACHABLE
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      sequenceId:
                        type: string
                      skipped:
                        type: array
                        items:
                          $ref: '#/components/schemas/SequenceSkip'
components:
  schemas:
    Sequence:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clinicId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - draft
          - active
          - paused
          - archived
        trigger:
          type: object
          additionalProperties: true
        steps:
          type: array
          items:
            $ref: '#/components/schemas/SequenceStep'
        analytics:
          type: object
          additionalProperties: true
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    SequenceSkip:
      type: object
      properties:
        userId:
          type: string
        reasons:
          type: array
          items:
            $ref: '#/components/schemas/SequenceSkipReason'
    SequenceStep:
      type: object
      description: A delay, email, or sms step. Requires an id (or step_id) and a type (or stepType). delay steps carry timeSeconds; email/sms steps carry a templateId or custom text.
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - delay
          - email
          - sms
        timeSeconds:
          type: number
          minimum: 0
        useCustomText:
          type: boolean
        templateId:
          type: string
          format: uuid
        customText:
          type: string
        customSubject:
          type: string
    SequenceSkipReason:
      type: string
      enum:
      - no_email
      - email_unsubscribed
      - not_opted_in_marketing
      - no_phone
      - sms_unsubscribed
      - not_opted_in_sms
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.