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

# Update an activity

> Updates an activity. Only the fields sent in the body are modified.

<Accordion title="Required scope">
`activities:write`
</Accordion>



## OpenAPI

````yaml /en/api-reference/openapi.json patch /v1/activities/{id}
openapi: 3.1.0
info:
  title: OAuth 2.1
  description: Endpoints for registering applications and managing OAuth 2.1 tokens.
  version: 1.0.0
  contact:
    name: Vendaze Support
    email: suporte@vendaze.com
servers:
  - url: https://api.vendaze.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: People
  - name: Companies
  - name: Deals
  - name: Pipelines
  - name: Tasks
  - name: Task Types
  - name: Activities
  - name: Products
  - name: Tags
  - name: Lists
  - name: Custom Fields
  - name: Webhooks
paths:
  /v1/activities/{id}:
    patch:
      tags:
        - Activities
      summary: Update an activity
      description: |-
        Updates an activity. Only the fields sent in the body are modified.

        <Accordion title="Required scope">
        `activities:write`
        </Accordion>
      operationId: updateActivity
      parameters:
        - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateActivityRequest'
      responses:
        '200':
          description: Activity updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: UUID of the resource.
  schemas:
    UpdateActivityRequest:
      type: object
      description: All fields are optional. Only fields included in the body are modified.
      properties:
        content_html:
          type: string
          nullable: true
          description: New HTML content. Send `null` to clear the content.
          example: <p>Proposal sent. Awaiting response.</p>
        files:
          type: array
          maxItems: 10
          nullable: true
          description: >-
            New complete file list. Replaces all existing files. Send `null` to
            remove all files.
          items:
            $ref: '#/components/schemas/ActivityFile'
    ActivityResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Activity'
    ActivityFile:
      type: object
      required:
        - content
      description: File to attach to the activity.
      properties:
        content:
          type: string
          description: Public HTTPS URL or base64 content of the file.
          example: https://storage.example.com/commercial-proposal.pdf
    Activity:
      type: object
      description: >-
        Full activity object returned in single-resource responses. Includes
        signed URLs for attached files.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the activity.
        entity:
          type: string
          nullable: true
          enum:
            - people
            - companies
            - deals
          description: Type of the entity linked to the activity.
          example: people
        entity_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the linked entity.
          example: c3d4e5f6-a7b8-9012-cdef-123456789012
        content_html:
          type: string
          description: Activity content in HTML.
          example: >-
            <p>Meeting held. Client confirmed interest in the Enterprise
            plan.</p>
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/Attachment'
          description: Attached files with signed URLs valid for 1 hour.
        owner:
          $ref: '#/components/schemas/Owner'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
              format: uuid
    ValidationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: Validation failed.
            fields:
              type: object
              additionalProperties:
                type: string
            request_id:
              type: string
              format: uuid
    Attachment:
      type: object
      description: File attached to the activity.
      properties:
        path:
          type: string
          description: File path in storage.
          example: workspaces/w1/people/c3d4/archives/Commercial_Proposal.pdf
        url:
          type: string
          nullable: true
          description: >-
            Signed URL valid for 1 hour for direct file download. `null` if URL
            generation fails.
          example: https://storage.vendaze.com/private/...?token=...
    Owner:
      type: object
      nullable: true
      description: >-
        Workspace member responsible for this activity. `null` when no owner is
        assigned.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: John Smith
        email:
          type: string
          format: email
          example: john@company.com
  responses:
    BadRequest:
      description: 'Malformed request body or empty update. Error code: `bad_request`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: bad_request
              message: Request body must be valid JSON.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: >-
        Token missing, invalid, or expired. Possible error codes:
        `unauthorized`, `token_expired`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: Missing or invalid Authorization header.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InsufficientScope:
      description: 'Token lacks the required scope. Error code: `insufficient_scope`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: insufficient_scope
              message: This endpoint requires the 'webhooks:read' scope.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: >-
        Webhook not found or belongs to another integration. Error code:
        `not_found`. Message: `"Webhook not found."`
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: Webhook not found.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    ValidationError:
      description: >-
        Input validation failed. Error code: `validation_error`. The `fields`
        object maps each invalid field to a description of the problem.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            error:
              code: validation_error
              message: Validation failed.
              fields:
                url: url must use HTTPS.
                events: At least one event is required.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    RateLimitExceeded:
      description: 'Rate limit exceeded. Error code: `rate_limit_exceeded`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit exceeded. Try again in 60 seconds.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalError:
      description: 'Unexpected server error. Error code: `internal_error`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal_error
              message: An unexpected error occurred.
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.1 access token.

````