> ## Documentation Index > Fetch the complete documentation index at: https://docs.evolutionfoundation.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Create a new pipeline > Create a pipeline with optional custom stages or default stages based on pipeline type ## OpenAPI ````yaml /api-reference/openapi/EvoAI-CRM-Service/pipelines.yaml post /api/v1/pipelines openapi: 3.0.4 info: title: Evolution Foundation - CRM Service - Pipelines description: Management of contacts, conversations, inboxes, labels and macros version: 1.1.0 servers: - url: https://api.evoai.app description: Production server - url: http://localhost:3000 description: Development server variables: port: default: '3000' - url: '{customUrl}' description: Custom server variables: customUrl: default: https://your-instance.com description: Enter your server URL security: [] paths: /api/v1/pipelines: post: summary: Create a new pipeline description: >- Create a pipeline with optional custom stages or default stages based on pipeline type operationId: create-pipeline requestBody: required: true content: application/json: schema: type: object required: - pipeline properties: pipeline: type: object required: - name - pipeline_type properties: name: type: string example: Sales Pipeline Q1 description: type: string example: Q1 sales tracking pipeline pipeline_type: type: string enum: - sales - support - onboarding - custom - marketing example: sales visibility: type: string enum: - private - team - public default: private custom_fields: type: object properties: attributes: type: array items: type: string example: - deal_value - closing_probability stages: type: array description: >- Optional custom stages (if not provided, use create_default_stages) items: type: object required: - name properties: name: type: string color: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ default: '#60A5FA' position: type: integer description: type: string create_default_stages: type: boolean description: If true, creates default stages based on pipeline_type default: false responses: '200': description: Pipeline created successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string description: Success message example: Pipeline created successfully example: success: true data: id: 550e8400-e29b-41d4-a716-446655440000 name: Sales Pipeline Q1 pipeline_type: sales meta: timestamp: '2024-01-15T10:30:00Z' message: Pipeline created successfully '400': description: Bad Request (invalid data) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: bad_request: summary: Invalid request data value: success: false error: code: BAD_REQUEST message: Invalid request data meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines method: POST '401': description: Unauthorized (invalid or missing token) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Unauthorized value: success: false error: code: UNAUTHORIZED message: Unauthorized meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines method: POST '403': description: Forbidden (insufficient permissions) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: forbidden: summary: Forbidden value: success: false error: code: FORBIDDEN message: Forbidden meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines method: POST '422': description: Unprocessable Entity (validation error) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validation_error: summary: Validation error value: success: false error: code: VALIDATION_ERROR message: Validation error details: name: Name is required pipeline_type: Pipeline type is required meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines method: POST '500': description: Internal Server Error (server error) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal_error: summary: Internal server error value: success: false error: code: INTERNAL_ERROR message: An internal server error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines method: POST security: - userApiKey: [] components: schemas: pipeline: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true pipeline_type: type: string enum: - sales - support - onboarding - custom - marketing visibility: type: string enum: - private - team - public is_active: type: boolean custom_fields: type: object properties: attributes: type: array items: type: string created_by_id: type: string format: uuid account_id: type: string format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time item_count: type: integer description: Total number of items in the pipeline conversations_count: type: integer description: Total number of conversations associated with the pipeline stages: type: array description: List of pipeline stages items: $ref: '#/components/schemas/pipeline_stage' pipeline_stages: type: array items: $ref: '#/components/schemas/pipeline_stage' pipeline_items: type: array items: $ref: '#/components/schemas/pipeline_item' ErrorResponse: type: object required: - success - error - meta properties: success: type: boolean example: false error: type: object required: - code - message properties: code: type: string example: VALIDATION_ERROR message: type: string example: Validation failed details: type: object additionalProperties: true nullable: true meta: type: object required: - timestamp - path - method properties: timestamp: type: string format: date-time example: '2024-01-15T10:30:00Z' path: type: string example: /public/api/v1/inboxes/{inbox_identifier}/contacts method: type: string example: POST pipeline_stage: type: object properties: id: type: string format: uuid pipeline_id: type: string format: uuid name: type: string color: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ position: type: integer stage_type: type: integer automation_rules: type: object custom_fields: type: object properties: attributes: type: array items: type: string created_at: type: string format: date-time updated_at: type: string format: date-time item_count: type: integer description: Number of items in this stage items: type: array description: List of pipeline items in this stage items: $ref: '#/components/schemas/pipeline_item' pipeline_item: type: object properties: id: type: string format: uuid pipeline_id: type: string format: uuid pipeline_stage_id: type: string format: uuid conversation_id: type: string format: uuid nullable: true contact_id: type: string format: uuid nullable: true assigned_by_id: type: string format: uuid nullable: true custom_fields: type: object description: Custom field values including services, currency, etc. entered_at: type: string format: date-time completed_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time is_lead: type: boolean description: True if contact-based (lead), false if conversation-based (deal) pipeline_stage: $ref: '#/components/schemas/pipeline_stage' conversation: $ref: '#/components/schemas/conversation' nullable: true contact: $ref: '#/components/schemas/contact' nullable: true tasks: type: array items: $ref: '#/components/schemas/pipeline_task' pending_tasks_count: type: integer overdue_tasks_count: type: integer completed_tasks_count: type: integer services_total_value: type: number description: Sum of all service values conversation: type: object properties: id: type: string format: uuid display_id: type: string format: uuid status: type: string enum: - open - resolved - pending - snoozed contact_id: type: string format: uuid inbox_id: type: string format: uuid assignee_id: type: string format: uuid nullable: true team_id: type: string format: uuid nullable: true account_id: type: string format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time last_activity_at: type: string format: date-time contact: $ref: '#/components/schemas/contact' assignee: $ref: '#/components/schemas/user' nullable: true inbox: type: object properties: id: type: string format: uuid channel_id: type: string format: uuid name: type: string channel_type: type: string enable_auto_assignment: type: boolean greeting_enabled: type: boolean greeting_message: type: string nullable: true working_hours_enabled: type: boolean out_of_office_message: type: string nullable: true timezone: type: string enable_email_collect: type: boolean csat_survey_enabled: type: boolean allow_messages_after_resolved: type: boolean auto_assignment_config: type: object additionalProperties: true lock_to_single_conversation: type: boolean csat_config: type: object additionalProperties: true sender_name_type: type: string business_name: type: string nullable: true display_name: type: string default_conversation_status: type: string nullable: true avatar_url: type: string working_hours: type: array items: type: object properties: day_of_week: type: integer closed_all_day: type: boolean open_hour: type: integer nullable: true open_minutes: type: integer nullable: true close_hour: type: integer nullable: true close_minutes: type: integer nullable: true open_all_day: type: boolean created_at: type: integer updated_at: type: integer provider: type: string contact: type: object properties: id: type: string format: uuid name: type: string email: type: string nullable: true phone_number: type: string nullable: true account_id: type: string format: uuid custom_attributes: type: object created_at: type: string format: date-time updated_at: type: string format: date-time pipeline_task: type: object properties: id: type: string format: uuid pipeline_item_id: type: string format: uuid account_id: type: string format: uuid title: type: string maxLength: 255 description: type: string nullable: true task_type: type: string enum: - call - email - meeting - follow_up - note - other status: type: string enum: - pending - completed - cancelled - overdue priority: type: string enum: - low - medium - high - urgent due_date: type: string format: date-time nullable: true completed_at: type: string format: date-time nullable: true created_by_id: type: string format: uuid assigned_to_id: type: string format: uuid nullable: true parent_task_id: type: string format: uuid nullable: true position: type: integer description: Position among siblings depth: type: integer description: Hierarchy depth (0=root, 1=subtask, 2=sub-subtask) metadata: type: object created_at: type: string format: date-time updated_at: type: string format: date-time created_by: $ref: '#/components/schemas/user' assigned_to: $ref: '#/components/schemas/user' nullable: true parent_task: $ref: '#/components/schemas/pipeline_task' nullable: true subtasks: type: array items: $ref: '#/components/schemas/pipeline_task' subtask_count: type: integer overdue: type: boolean due_soon: type: boolean days_until_due: type: integer nullable: true hours_until_due: type: number nullable: true user: type: object properties: id: type: string format: uuid name: type: string email: type: string avatar_url: type: string nullable: true available_name: type: string description: Display name for the user securitySchemes: userApiKey: type: apiKey in: header name: api_access_token ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.