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

# Add internal comment to deal

> Appends an internal comment to the deal (stored as a WordPress comment
with `comment_type = deal_comment`). The comment is visible to the sales
rep and admins, not to the customer.

**Nonce:** `sagescreen_frontend_nonce`
**Capability:** `ss_sales` or `ss_sales_admin` or `ss_admin_all`




## OpenAPI

````yaml /openapi/private/specs/wp/deal-internal.yml post /wp-admin/admin-ajax.php?action=sagescreen_add_deal_comment
openapi: 3.1.0
info:
  title: SageScreen — Deal Module
  description: >
    Enterprise deal lifecycle management. Deals represent sales proposals that

    flow through a multi-stage approval and payment pipeline before provisioning

    a council.


    **CPT:** `ss_deal`

    **Custom statuses:** `draft`, `ss_pending_approval`, `ss_approved`,

    `ss_customer_sent`, `ss_customer_approved`, `ss_customer_rejected`,

    `ss_invoiced`, `ss_paid`, `ss_closed`, `ss_lost`


    **Business rule:** Only Enterprise (E-SKU) products go through the
    deal/sales

    process. Packs and subscriptions are not sold via deals. Trials are
    Stripe-only.
  version: 1.0.0
servers:
  - url: https://{domain}/wp-json/sagescreen/v1
    description: WordPress REST API
    variables:
      domain:
        default: api.sagescreen.app
security: []
tags:
  - name: Deal REST
    description: REST API endpoints authenticated via X-API-Key
  - name: Deal AJAX
    description: AJAX endpoints authenticated via WordPress nonce + capability check
paths:
  /wp-admin/admin-ajax.php?action=sagescreen_add_deal_comment:
    post:
      tags:
        - Deal AJAX
      summary: Add internal comment to deal
      description: |
        Appends an internal comment to the deal (stored as a WordPress comment
        with `comment_type = deal_comment`). The comment is visible to the sales
        rep and admins, not to the customer.

        **Nonce:** `sagescreen_frontend_nonce`
        **Capability:** `ss_sales` or `ss_sales_admin` or `ss_admin_all`
      operationId: ajaxAddDealComment
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - nonce
                - action
                - deal_id
                - comment
              properties:
                nonce:
                  type: string
                  examples:
                    - abc123def456
                action:
                  type: string
                  const: sagescreen_add_deal_comment
                deal_id:
                  type: integer
                  examples:
                    - 1042
                comment:
                  type: string
                  description: Comment body (required)
                  examples:
                    - >-
                      Spoke with the customer - they need a revised quote by
                      Friday.
      responses:
        '200':
          description: Comment added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AjaxAddCommentResponse'
              example:
                success: true
                data:
                  comment_id: 287
                  author: Jane Smith
                  date: Feb 19, 2026 2:30 PM
                  content: >-
                    Spoke with the customer - they need a revised quote by
                    Friday.
        '400':
          description: Bad request — missing fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AjaxErrorResponse'
              examples:
                missingFields:
                  summary: Deal ID or comment missing
                  value:
                    success: false
                    data:
                      message: Deal ID and comment are required
                notFound:
                  summary: Deal not found
                  value:
                    success: false
                    data:
                      message: Deal not found
        '403':
          $ref: '#/components/responses/AjaxForbidden'
      security:
        - wpAjaxNonce: []
components:
  schemas:
    AjaxAddCommentResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - comment_id
            - author
            - date
            - content
          properties:
            comment_id:
              type: integer
              examples:
                - 287
            author:
              type: string
              examples:
                - Jane Smith
            date:
              type: string
              description: Formatted datetime via `sage_screen_format_datetime()`
              examples:
                - Feb 19, 2026 2:30 PM
            content:
              type: string
              examples:
                - Spoke with the customer - they need a revised quote by Friday.
    AjaxErrorResponse:
      type: object
      description: WordPress AJAX error envelope (wp_send_json_error)
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          const: false
        data:
          oneOf:
            - type: object
              properties:
                message:
                  type: string
                  description: Human-readable error message
                  examples:
                    - Deal not found
                errors:
                  type: array
                  description: Validation error list (submit_deal only)
                  items:
                    type: string
                  examples:
                    - - Customer name is required
                      - Contact email is required
                redirect_edit:
                  type: boolean
                  description: Whether front end should redirect to edit form
                  examples:
                    - true
                edit_url:
                  type: string
                  description: URL to redirect to for fixing validation errors
                  examples:
                    - /admin/sales/calc?deal=1042
            - type: string
              description: Simple error message string
              examples:
                - Deal not found
  responses:
    AjaxForbidden:
      description: User does not have the required capability
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AjaxErrorResponse'
          example:
            success: false
            data:
              message: You do not have permission to perform this action
  securitySchemes:
    wpAjaxNonce:
      type: apiKey
      in: query
      name: nonce
      description: |
        WordPress AJAX nonce — either `sagescreen_frontend_nonce` or
        `sagescreen_sales_calc` depending on the endpoint (see each endpoint
        description). Sent as a form field in the POST body.

````