> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Merge planner items > Merge duplicate planner items of one company into a single item. targetId is kept; sourceIds are merged into it: linked devices, tickets, licenses, goals, projects, compliance and other records, cost lines, notes, attachments, tasks and draft budget lines move to the kept item, hours add up, and the merged items are archived (restore one with PATCH /planner/items/{id} isArchived=false). Items kept in sync by a standard or an automation rule, and items whose devices are kept linked by conditions, cannot be merged. MSP staff with Planner manage permission only. Requires `planner.write` and manage_planner. ## OpenAPI ````yaml /openapi.json post /api/public/v1/planner/items/merge openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production (US) - url: https://eu.msportal.ai description: Production (EU) security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics - name: Client Onboarding description: >- Client onboarding - portals (phases, tasks, contacts, activation), templates, checklist templates, forms and documentation pages - name: Backup description: >- Backup - summaries, protected devices, alerts and SaaS protection (Datto, Axcient, Slide, Kaseya) - name: Microsoft 365 description: Microsoft 365 - licenses, users, domains and Secure Score - name: Security description: >- Security - posture summary, EDR incidents, vulnerabilities, email threats, firewalls, DNS filtering and security awareness - name: Financial description: Financial - quotes, invoices and revenue summaries - name: Integrations description: Integrations - status, sync health, pause and resume (never credentials) - name: Documentation description: >- Documentation - pages, folders and articles synced from Hudu or IT Glue, plus built-in pages - name: Broadcasts description: Broadcasts - emergency broadcasts, recipients and groups - name: Notifications description: Notifications - the linked user's in-app notifications - name: Standards description: >- Standards - technology standards catalog, service plans, applicability, deployment statuses, compliance rollups, white space and costs - name: Customer Success description: >- Customer success - client health scores, trends, benchmarks and Traffic Light Reviews - name: Tasks description: Tasks - the linked user's personal task list - name: Tenant Setup description: Tenant setup - profile, branding and portal settings (never secrets) - name: Roles description: Roles - staff and client roles and their permission grants - name: Ticket Templates description: Ticket templates - reusable ticket definitions - name: Readiness description: Client readiness - account readiness assessments - name: Projects description: >- Projects - PSA projects with health overlays (deliverables, milestones, client actions, weekly updates), phases, tickets, time entries, PSA status/owner/priority write-through, ticket notes, task controls, display settings and the document library paths: /api/public/v1/planner/items/merge: post: tags: - Planner summary: Merge planner items description: >- Merge duplicate planner items of one company into a single item. targetId is kept; sourceIds are merged into it: linked devices, tickets, licenses, goals, projects, compliance and other records, cost lines, notes, attachments, tasks and draft budget lines move to the kept item, hours add up, and the merged items are archived (restore one with PATCH /planner/items/{id} isArchived=false). Items kept in sync by a standard or an automation rule, and items whose devices are kept linked by conditions, cannot be merged. MSP staff with Planner manage permission only. Requires `planner.write` and manage_planner. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MergePlannerItemsRequest' responses: '200': description: Items merged content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PlannerMergeResult' required: - data '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - missing scope (planner.write) or the linked user lacks manage_planner content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: A selected planner item was not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The selection cannot be merged (mixed companies, standards-, automation- or criteria-managed items, archived target, hidden source on a visible target, too many cost lines) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: MergePlannerItemsRequest: type: object properties: targetId: type: string format: uuid description: Planner item to keep sourceIds: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: >- Planner items to merge into the kept item and archive (1-50, same company, distinct, not the target) required: - targetId - sourceIds PlannerMergeResult: type: object properties: targetId: type: string format: uuid mergedIds: type: array items: type: string format: uuid description: Source items, now archived moves: type: object properties: devices: type: integer tickets: type: integer licenses: type: integer goals: type: integer projects: type: integer opportunities: type: integer invoices: type: integer secure_score: type: integer compliance: type: integer security_findings: type: integer meetings: type: integer tasks: type: integer attachments: type: integer budget_lines: type: integer cost_lines: type: integer notes: type: integer custom_fields: type: integer tags: type: integer description: How many records of each kind moved to the kept item lockedBudgetLines: type: integer description: >- Budget lines that stayed on the sources because their budget is locked required: - targetId - mergedIds - moves - lockedBudgetLines ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.