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

# Create a pipeline

> Creates the pipeline in the project of the API key and answers 201 with the created record.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/pipelines
openapi: 3.0.3
info:
  title: Leadstaker API
  version: 1.0.0
  description: Public REST API for Leadstaker projects.
servers:
  - url: https://n-api.leadstaker.com
    description: Production
security: []
tags:
  - name: Fields
    description: >-
      Custom field definitions, both the built-in ones and the ones a project
      creates.
  - name: Field groups
    description: Sections that organize custom fields in the interface.
  - name: Deals
    description: Opportunities moving through a pipeline, each tied to a contact.
  - name: Contacts
    description: >-
      People inside a project, holding the custom field values collected about
      them.
  - name: Messages
    description: Individual messages inside a chat, inbound and outbound.
  - name: Chats
    description: Conversations with a contact over a connected channel.
  - name: Loss reasons
    description: The catalog of reasons a deal can be marked as lost.
  - name: Pipelines
    description: Ordered sets of stages a deal travels through.
  - name: Stages
    description: Steps inside a pipeline, including the built-in open and closed ones.
  - name: Tags
    description: Free-form labels attached to deals.
  - name: Notes
    description: >-
      Free text attached to a contact or a deal, written by a user, an agent, or
      the system.
paths:
  /v1/pipelines:
    post:
      tags:
        - Pipelines
      summary: Create a pipeline
      description: >-
        Creates the pipeline in the project of the API key and answers 201 with
        the created record.
      operationId: postPipelines
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                appearanceConfig:
                  type: object
                  properties:
                    card:
                      type: object
                      properties:
                        topLeft:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        topRight:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        primaryTitle:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        primaryValue:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        middleLeft:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        middleRight:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        bottomLeft:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        bottomRight:
                          type: object
                          properties:
                            customFieldId:
                              type: string
                              minLength: 1
                              nullable: true
                          additionalProperties: false
                        showTags:
                          type: boolean
                      additionalProperties: false
                  additionalProperties: false
              required:
                - name
              additionalProperties: false
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  archivedAt:
                    type: string
                    format: date-time
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  name:
                    type: string
                    minLength: 1
                  projectId:
                    type: string
                    minLength: 1
                  sort:
                    type: string
                    enum:
                      - CREATED_AT_ASC
                      - CREATED_AT_DESC
                  appearanceConfig:
                    type: object
                    properties:
                      card:
                        type: object
                        properties:
                          topLeft:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          topRight:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          primaryTitle:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          primaryValue:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          middleLeft:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          middleRight:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          bottomLeft:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          bottomRight:
                            type: object
                            properties:
                              customFieldId:
                                type: string
                                minLength: 1
                                nullable: true
                            additionalProperties: false
                          showTags:
                            type: boolean
                        additionalProperties: false
                    additionalProperties: false
                  stages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                        position:
                          type: integer
                          minimum: 0
                        type:
                          type: string
                          enum:
                            - OPEN
                            - CLOSED
                        color:
                          type: string
                          enum:
                            - '#2563EB'
                            - '#16A34A'
                            - '#EA580C'
                            - '#DC2626'
                            - '#7C3AED'
                            - '#0891B2'
                            - '#DB2777'
                            - '#4B5563'
                        pipelineId:
                          type: string
                          minLength: 1
                        archivedAt:
                          type: string
                          format: date-time
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - name
                        - position
                        - type
                        - color
                      additionalProperties: false
                required:
                  - id
                  - createdAt
                  - updatedAt
                  - name
                  - projectId
                  - sort
                additionalProperties: false
              example:
                id: 670fa8b21d94cc0010e3c7a5
                name: Vendas
                projectId: 665f1c2e8a94b70012d4e9a1
                sort: CREATED_AT_DESC
                createdAt: '2026-01-12T14:08:00.000Z'
                updatedAt: '2026-01-15T09:32:00.000Z'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The payload failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      required:
        - errorCode
        - message
        - status
      properties:
        errorCode:
          type: string
        message:
          type: string
        status:
          type: integer
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - code
              - message
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````