openapi: 3.0.4 info: title: Evolution Foundation - CRM Service - Pipeline Stages 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 paths: /api/v1/pipelines/{pipeline_id}/pipeline_stages: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid get: operationId: list-pipeline-stages summary: List all stages in a pipeline description: Get all stages for a specific pipeline ordered by position security: - userApiKey: [] responses: '200': description: Success content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: type: array items: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Pipeline stages retrieved successfully examples: success: value: success: true data: - id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: New Lead color: '#3B82F6' position: 1 stage_type: 0 automation_rules: description: New interested contacts custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:30:00Z' - id: 880e8400-e29b-41d4-a716-446655440003 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: Qualification color: '#F59E0B' position: 2 stage_type: 0 automation_rules: description: Interest and fit verification custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:30:00Z' meta: timestamp: '2024-01-15T10:30:00Z' message: Pipeline stages retrieved successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid pipeline ID format meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: GET '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: GET '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to access this pipeline meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: GET '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: GET '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: GET post: operationId: create-pipeline-stage summary: Create a new stage description: Add a new stage to the pipeline security: - userApiKey: [] requestBody: required: true content: application/json: schema: type: object required: - pipeline_stage properties: pipeline_stage: type: object required: - name properties: name: type: string example: Negotiation color: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ example: '#10B981' stage_type: type: integer default: 0 automation_rules: type: object custom_fields: type: object properties: attributes: type: array items: type: string responses: '200': description: Stage created successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Pipeline stage created successfully examples: success: value: success: true data: id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: Negotiation color: '#10B981' position: 3 stage_type: 0 automation_rules: description: Negotiation phase custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:30:00Z' meta: timestamp: '2024-01-15T10:30:00Z' message: Pipeline stage created successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid request data meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to create stages in this pipeline meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: VALIDATION_ERROR message: Validation failed details: name: - is required meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages method: POST /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid patch: operationId: reorder-stages summary: Reorder stages description: Set custom order for all stages in the pipeline security: - userApiKey: [] requestBody: required: true content: application/json: schema: type: object properties: stage_orders: type: array items: type: string format: uuid description: Array of stage IDs in desired order responses: '200': description: Stages reordered successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: type: array items: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Stages reordered successfully examples: success: value: success: true data: - id: 880e8400-e29b-41d4-a716-446655440003 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: Qualification color: '#F59E0B' position: 1 stage_type: 0 automation_rules: description: Interest and fit verification custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:35:00Z' - id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: New Lead color: '#3B82F6' position: 2 stage_type: 0 automation_rules: description: New interested contacts custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:35:00Z' meta: timestamp: '2024-01-15T10:35:00Z' message: Stages reordered successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid stage IDs provided meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to reorder stages meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: VALIDATION_ERROR message: Validation failed details: stage_orders: - All stage IDs must belong to this pipeline meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/reorder method: PATCH /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid get: operationId: get-pipeline-stage summary: Get a single stage security: - userApiKey: [] responses: '200': description: Success content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Pipeline stage retrieved successfully examples: success: value: success: true data: id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: New Lead color: '#3B82F6' position: 1 stage_type: 0 automation_rules: description: New interested contacts custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:30:00Z' meta: timestamp: '2024-01-15T10:30:00Z' message: Pipeline stage retrieved successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid stage ID format meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: GET '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: GET '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to access this stage meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: GET '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: GET '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: GET patch: operationId: update-pipeline-stage summary: Update a stage security: - userApiKey: [] requestBody: required: true content: application/json: schema: type: object required: - pipeline_stage properties: pipeline_stage: type: object properties: name: type: string color: type: string stage_type: type: integer automation_rules: type: object custom_fields: type: object responses: '200': description: Stage updated successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Pipeline stage updated successfully examples: success: value: success: true data: id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: Updated Stage Name color: '#10B981' position: 1 stage_type: 0 automation_rules: description: Updated description custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:35:00Z' meta: timestamp: '2024-01-15T10:35:00Z' message: Pipeline stage updated successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid request data meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to update this stage meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: VALIDATION_ERROR message: Validation failed details: color: - Invalid color format meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: PATCH delete: operationId: delete-pipeline-stage summary: Delete a stage description: Delete a stage (only if it has no items) security: - userApiKey: [] responses: '200': description: Stage deleted successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: type: object nullable: true example: null meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Pipeline stage deleted successfully examples: success: value: success: true data: null meta: timestamp: '2024-01-15T10:30:00Z' message: Pipeline stage deleted successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid stage ID format meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to delete this stage meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: VALIDATION_ERROR message: Cannot delete stage with items meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} method: DELETE /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid post: operationId: bulk-move-conversations summary: Move all items from one stage to another security: - userApiKey: [] requestBody: required: true content: application/json: schema: type: object required: - from_stage_id - to_stage_id properties: from_stage_id: type: string format: uuid to_stage_id: type: string format: uuid responses: '200': description: Items moved successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: type: object properties: moved_count: type: integer description: Number of items moved example: 5 meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Items moved successfully examples: success: value: success: true data: moved_count: 5 meta: timestamp: '2024-01-15T10:30:00Z' message: Items moved successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Invalid stage IDs provided meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to move items meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: VALIDATION_ERROR message: Validation failed details: from_stage_id: - is required to_stage_id: - is required meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/bulk_move_conversations method: POST /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid patch: operationId: move-stage-down summary: Move stage down one position security: - userApiKey: [] responses: '200': description: Stage moved successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Stage moved down successfully examples: success: value: success: true data: id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: New Lead color: '#3B82F6' position: 2 stage_type: 0 automation_rules: description: New interested contacts custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:35:00Z' meta: timestamp: '2024-01-15T10:35:00Z' message: Stage moved down successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Stage is already at the last position meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down method: PATCH '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down method: PATCH '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to reorder stages meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down method: PATCH '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down method: PATCH '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_down method: PATCH /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up: parameters: - name: pipeline_id in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid patch: operationId: move-stage-up summary: Move stage up one position security: - userApiKey: [] responses: '200': description: Stage moved successfully content: application/json: schema: type: object required: - success - data - meta - message properties: success: type: boolean example: true data: $ref: '#/components/schemas/pipeline_stage' meta: type: object properties: timestamp: type: string format: date-time description: Response timestamp example: '2024-01-15T10:30:00Z' message: type: string example: Stage moved up successfully examples: success: value: success: true data: id: 770e8400-e29b-41d4-a716-446655440002 pipeline_id: 550e8400-e29b-41d4-a716-446655440000 name: New Lead color: '#3B82F6' position: 1 stage_type: 0 automation_rules: description: New interested contacts custom_fields: attributes: [] created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:35:00Z' meta: timestamp: '2024-01-15T10:35:00Z' message: Stage moved up successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: BAD_REQUEST message: Stage is already at the first position meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up method: PATCH '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or missing authentication token meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up method: PATCH '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: You do not have permission to reorder stages meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up method: PATCH '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: NOT_FOUND message: Pipeline stage not found meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up method: PATCH '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: INTERNAL_SERVER_ERROR message: An unexpected error occurred meta: timestamp: '2024-01-15T10:30:00Z' path: /api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}/move_up method: PATCH components: schemas: 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 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 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 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 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_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 ApiAccessToken: type: apiKey in: header name: api_access_token description: API access token for user authentication