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

# Update deal activity (note) by ID

> Update the content of an existing deal activity. Set `content_type` to `"text"` for plain text (auto-converted to HTML) or `"html"` for raw HTML input.



## OpenAPI

````yaml /api-reference/openapi-v1.json patch /v1/deal-activities/{id}
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/deal-activities/{id}:
    patch:
      tags:
        - Deal Activities
      summary: Update deal activity (note) by ID
      description: >-
        Update the content of an existing deal activity. Set `content_type` to
        `"text"` for plain text (auto-converted to HTML) or `"html"` for raw
        HTML input.
      operationId: updateDealActivityById
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            description: Deal activity UUID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDealActivityBody'
      responses:
        '200':
          description: Deal activity updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDealActivityResponse'
              example:
                success: true
                data:
                  id: 901e2345-e67f-89ab-cdef-456789012345
                  updated_at: '2024-03-15T12:00:00Z'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    UpdateDealActivityBody:
      type: object
      properties:
        activity_content:
          type: string
          description: New content for the deal activity. Format depends on content_type.
        content_type:
          type: string
          enum:
            - text
            - html
          default: text
          description: >-
            Format of activity_content. "text" for plain text (auto-converted to
            HTML), "html" for raw HTML.
      required:
        - activity_content
    UpdateDealActivityResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: Updated deal activity UUID.
            updated_at:
              type: string
              description: ISO 8601 update timestamp.
          required:
            - id
            - updated_at
      required:
        - success
        - data
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````