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

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers.
> Scope requests by locationId rather than projectName.
> Read the guide linked from each API reference group before recommending an endpoint.

# Create native sub-account

> Create a sub-account without connecting an external CRM. Requires projects:write and an agency admin. Ownership and plan limits are enforced. Use the returned data.locationId to create an agent and its campaign. This does not create an agent or start calls. List projects first to reuse a suitable existing sub-account. If a response is lost, list projects before retrying; this operation is not idempotent.

Required API key scope: `projects:write`.



## OpenAPI

````yaml /openapi.yaml post /api/v2/projects/native
openapi: 3.1.0
info:
  title: TFUAI Server API
  version: 1.0.0
  description: >-
    API reference for the TFUAI SaaS server.


    All published endpoints are mounted under `/api`. Responses use a standard
    envelope: `{ "success": true, ... }` on success and `{ "success": false,
    "error": "..." }` on failure.


    Product API modules are being launched module by module. This spec currently
    exposes only contracted public modules.


    Authenticate public API requests with an API key in the `Authorization`
    header: `Authorization: Bearer YOUR_API_KEY`.
servers:
  - url: https://api.teamfollowup.ai
    description: Production API origin. Public API paths are under /api.
security: []
tags:
  - name: Agents
    description: >-
      Build the conversation: identity and settings, script, lead context and
      split testing.
  - name: Analytics
    description: >-
      Understand call volume, pickup, booking and transfer metrics within the
      selected reporting scope.
  - name: Billing
    description: >-
      Balances, spend, purchases and sub-account rebilling. Reference and guides
      only; the builder chatbot has no billing playbook.
  - name: Calls
    description: >-
      Review completed calls, recordings, transcripts and campaign run history;
      distinguish observation from placing a new call.
  - name: Campaigns
    description: >-
      Configure what starts calls, who is eligible, calling windows, caller IDs,
      activation and the actions that follow each outcome.


      What runs after a call lands: for each outcome (booked, opted out, asked
      for a callback…), an ordered chain of actions — tag the contact, move a
      pipeline stage, send an SMS, book an appointment. Stored as a graph:
      `nodes` are the actions, `edges` say what follows what, and
      `dispositionEntries` maps each outcome to the node its chain starts at.


      **Pick the narrowest endpoint that does the job.**


      | To | Call | |

      | --- | --- | --- |

      | See what fires per outcome | `GET .../workflow?view=summary` | Reads as
      plain text, no graph walking |

      | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server
      derives node ids, edge ids, handles, layout |

      | Change a message, tag or setting | `PATCH .../workflow` | Merges;
      carries no graph, so it cannot damage one |

      | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain
      around it |

      | Author or replace the whole graph | `PUT .../workflow` | Replaces
      everything you send |


      `PUT` is the only one that can re-wire, position nodes, build an `if`,
      save an unconfigured draft, or copy a whole workflow — and the only one
      that can overwrite a change someone else made after you read it. Use it
      when you are genuinely authoring the graph, and send `expectedVersion`
      when you do. For everything else the narrower endpoints are both easier
      and safer.
  - name: Contacts
    description: >-
      Find contacts and their calls, manage do-not-call status and identify
      internal contacts excluded from reporting.
  - name: In-call Capabilities
    description: >-
      Configure actions and instructions the agent uses during a live call:
      booking, transfers, lookups and custom skills.
  - name: Master agent
    description: >-
      Run a shared agent and campaign across linked projects; manage
      inheritance, local bindings, synchronization and rollout readiness.
  - name: Native Calendar
    description: >-
      The diary of a sub-account with no CRM: its bookable calendars, the free
      slots they offer, and the appointments on them. Availability is computed
      per request against live bookings and is never cached, because a cached
      slot is one somebody else has already taken.
  - name: Native Contacts
    description: >-
      The people a sub-account with no CRM calls, and the fields it keeps on
      them. This is the system of record for those contacts: there is nowhere
      else they exist. A sub-account with a CRM keeps its contacts there and
      every operation here answers 400 for it.
  - name: Phone Numbers
    description: >-
      Find and manage caller IDs, assign numbers to campaigns and understand
      connected Twilio numbers.
  - name: Projects
    description: >-
      Understand project ownership, inspect configuration and validate the local
      resources used by a campaign.
  - name: TFU Live
    description: >-
      Configure instructions, conversation style, workflows, Chat and call
      handling, then test and go live.
  - name: Voices
    description: >-
      Browse the voice catalogue and select a voice; configure speech and
      listening behavior in Agents.
paths:
  /api/v2/projects/native:
    post:
      tags:
        - Projects
      summary: Create native sub-account
      description: >-
        Create a sub-account without connecting an external CRM. Requires
        projects:write and an agency admin. Ownership and plan limits are
        enforced. Use the returned data.locationId to create an agent and its
        campaign. This does not create an agent or start calls. List projects
        first to reuse a suitable existing sub-account. If a response is lost,
        list projects before retrying; this operation is not idempotent.


        Required API key scope: `projects:write`.
      operationId: post-v2-projects-native
      requestBody:
        required: true
        description: Business name and timezone for the new native sub-account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectsNativeCreateRequest'
            examples:
              default:
                value:
                  businessName: Riverside Dental
                  timezone: America/New_York
      responses:
        '201':
          description: >-
            Native sub-account created. A plan-cap race may return a created but
            inactive account with a message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsNativeCreateResponse'
              examples:
                default:
                  value:
                    success: true
                    data:
                      locationId: nat_example
                      businessName: Riverside Dental
                      crm: native
                      agencyTag: Acme Agency
        '400':
          description: Validation failed or the request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: VALIDATION
                    message: businessName is required.
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unauthorized
                    message: Authentication required.
        '403':
          description: Authenticated but not permitted to access the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Forbidden
                    message: You do not have permission to access this resource.
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: TooManyRequests
                    message: Too many requests, please try again later.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: InternalError
                    message: Unexpected server error.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request POST \
              --url https://api.teamfollowup.ai/api/v2/projects/native \
              --header 'Authorization: Bearer YOUR_API_KEY' \
              --header 'Content-Type: application/json' \
              --data '{
              "businessName": "Riverside Dental",
              "timezone": "America/New_York"
            }'
components:
  schemas:
    ProjectsNativeCreateRequest:
      type: object
      additionalProperties: false
      required:
        - businessName
        - timezone
      properties:
        businessName:
          type: string
          minLength: 1
          description: Name of the business this sub-account serves.
        timezone:
          type: string
          minLength: 1
          description: IANA timezone, for example America/New_York.
        agencyTag:
          type: string
          minLength: 1
          description: >-
            Required for staff creating for a named agency. Agency admins always
            create within their own agency.
    ProjectsNativeCreateResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - data
      properties:
        success:
          const: true
        message:
          type: string
        data:
          type: object
          additionalProperties: {}
          required:
            - locationId
            - businessName
            - crm
          properties:
            locationId:
              type: string
            businessName:
              type: string
            crm:
              const: native
            agencyTag:
              type:
                - string
                - 'null'
    ProjectsErrorResponse:
      type: object
      additionalProperties: {}
      required:
        - success
      properties:
        success:
          type: boolean
        error:
          type: string
          example: VALIDATION
        code:
          type: string
          example: SubAccountCapReached
        message:
          type: string
          example: Project not found.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.