> ## 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. # Add ticket note > Post a note to the ticket in the client's PSA (Halo, ConnectWise, Autotask, Syncro) as the linked user. A configured customer-reply status may be applied after a company user's public note; posted=true means the note is saved even if statusUpdate.success=false. Use the reply-status/retry endpoint with statusUpdate.retry to retry only the status; never repost the note. Requires `tickets.write` and write_tickets_notes or write_tickets. ## OpenAPI ````yaml /openapi.json post /api/public/v1/tickets/{id}/notes 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/tickets/{id}/notes: post: tags: - Tickets summary: Add ticket note description: >- Post a note to the ticket in the client's PSA (Halo, ConnectWise, Autotask, Syncro) as the linked user. A configured customer-reply status may be applied after a company user's public note; posted=true means the note is saved even if statusUpdate.success=false. Use the reply-status/retry endpoint with statusUpdate.retry to retry only the status; never repost the note. Requires `tickets.write` and write_tickets_notes or write_tickets. parameters: - schema: type: string minLength: 1 maxLength: 255 description: >- PSA ticket number by default; the internal id returned by list/search with byInternalId=true required: true description: >- PSA ticket number by default; the internal id returned by list/search with byInternalId=true name: id in: path - schema: type: boolean default: false description: Resolve only the internal ID returned by list/search required: false description: Resolve only the internal ID returned by list/search name: byInternalId in: query - schema: type: string format: uuid description: >- Integration from ticket.reference; disambiguates IDs across PSA integrations required: false description: >- Integration from ticket.reference; disambiguates IDs across PSA integrations name: integrationId in: query requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddTicketNoteRequest' responses: '201': description: Note posted to the PSA content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AddTicketNoteResult' 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 (tickets.write), the linked user lacks the tickets permission, or no PSA integration is active content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Ticket not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: The PSA rejected the note content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: AddTicketNoteRequest: type: object properties: content: type: string minLength: 1 maxLength: 10000 description: Note body posted to the PSA isInternal: type: boolean default: false description: Post as an internal/private note instead of a client-visible one ccContactIds: type: array items: type: string format: uuid maxItems: 10 description: >- Contact ids from note-recipient-options to email this client-visible note to. With ccEmails, up to 10 people in all. Never allowed with isInternal. Requires note emails to be turned on in Settings > Tickets. ccEmails: type: array items: type: string maxLength: 254 format: email maxItems: 10 description: >- Email addresses to email this client-visible note to, for people who are not listed contacts. Never allowed with isInternal. required: - content AddTicketNoteResult: type: object properties: posted: type: boolean enum: - true description: The note is saved in the PSA even when statusUpdate.success=false ticketId: type: string description: PSA ticket id provider: type: string recipientDelivery: oneOf: - type: object properties: status: type: string enum: - none required: - status - type: object properties: status: type: string enum: - sent - queued - failed count: type: integer required: - status - count description: >- What happened to the CC recipients: none requested, sent/queued, or failed (the note is still posted) statusUpdate: type: object nullable: true properties: success: type: boolean statusName: type: string description: Status applied (success=true) skipped: type: string enum: - closed - changed - disabled description: >- success=true but nothing changed: the ticket is closed, its status changed meanwhile, or the setting is off error: type: string description: Why the status update failed (success=false) retry: allOf: - $ref: '#/components/schemas/TicketReplyStatusRetry' - description: >- Present when the failed status step can be retried via POST /tickets/{id}/reply-status/retry required: - success description: >- Outcome of the configured customer-reply status change (Autotask), when one applies required: - posted - ticketId - provider - recipientDelivery 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 TicketReplyStatusRetry: type: object properties: integrationId: type: string format: uuid ticketId: type: string description: PSA ticket id localTicketId: type: string description: Internal ticket id noteId: type: string statusId: type: string expectedStatusId: type: string nullable: true token: type: string description: Signed receipt; pass it back unchanged required: - integrationId - ticketId - localTicketId - noteId - statusId - expectedStatusId - token description: Signed receipt for the status step of an already-saved customer note 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.