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

# Create activity

> Create a new activity on a change request. Activities include approval, rejection, comments, and completion actions.



## OpenAPI

````yaml /openapi/brms.json post /api/projects/{projectId}/change-requests/{changeRequestId}/activities
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/change-requests/{changeRequestId}/activities:
    post:
      tags:
        - Change requests
      summary: Create activity
      description: >-
        Create a new activity on a change request. Activities include approval,
        rejection, comments, and completion actions.
      operationId: createChangeRequestActivity
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project unique identifier
        - schema:
            type: string
            format: uuid
          in: path
          name: changeRequestId
          required: true
          description: Change request unique identifier
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - create
                    - comment
                    - approve
                    - unapprove
                    - reject
                    - cancel
                    - complete
                  description: Activity type to perform
                comment:
                  type: string
                  nullable: true
                  description: Optional comment for the activity
                requestChange:
                  type: boolean
                  default: false
                  description: Whether to request changes
              required:
                - type
        required: true
      responses:
        '200':
          description: Updated change request with the new activity
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Change request unique identifier
                  type:
                    type: string
                    enum:
                      - publish_document
                      - unpublish_document
                      - deploy_environment
                      - undeploy_environment
                      - merge_branch
                    description: Type of change request
                  status:
                    type: string
                    enum:
                      - pending
                      - rejected
                      - cancelled
                      - completed
                    description: Current status of the change request
                  description:
                    type: string
                    nullable: true
                    description: Change request description
                  projectId:
                    type: string
                    format: uuid
                    description: Project unique identifier
                  document:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Document unique identifier
                      name:
                        type: string
                        description: Document name
                      key:
                        type: string
                        nullable: true
                        description: Document key
                    required:
                      - id
                      - name
                    description: Document information
                  documentId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Document unique identifier
                  environment:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Environment unique identifier
                      name:
                        type: string
                        description: Environment name
                    required:
                      - id
                      - name
                    description: Environment information
                  environmentId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Environment unique identifier
                  release:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Release unique identifier
                      name:
                        type: string
                        description: Release name
                      version:
                        type: string
                        nullable: true
                        description: Release version
                    required:
                      - id
                      - name
                    description: Release information
                  releaseId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Release unique identifier
                  branch:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Branch unique identifier
                      name:
                        type: string
                        description: Branch name
                    required:
                      - id
                      - name
                    description: Branch information
                  branchId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Branch unique identifier
                  commit:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Commit unique identifier
                      message:
                        type: string
                        nullable: true
                        description: Commit message
                    required:
                      - id
                    description: Commit information
                  createdAt:
                    type: string
                    description: Change request creation timestamp
                  createdBy:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: User unique identifier
                      email:
                        type: string
                        format: email
                        description: User email address
                      firstName:
                        type: string
                        nullable: true
                        description: User first name
                      lastName:
                        type: string
                        nullable: true
                        description: User last name
                    required:
                      - id
                      - email
                      - firstName
                      - lastName
                    description: User information
                  updatedAt:
                    type: string
                    description: Change request last update timestamp
                  activities:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Activity unique identifier
                        type:
                          type: string
                          enum:
                            - create
                            - comment
                            - approve
                            - unapprove
                            - reject
                            - cancel
                            - complete
                          description: Activity type
                        comment:
                          type: string
                          nullable: true
                          description: Activity comment
                        createdAt:
                          type: string
                          description: Activity creation timestamp
                        createdBy:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: User unique identifier
                            email:
                              type: string
                              format: email
                              description: User email address
                            firstName:
                              type: string
                              nullable: true
                              description: User first name
                            lastName:
                              type: string
                              nullable: true
                              description: User last name
                          required:
                            - id
                            - email
                            - firstName
                            - lastName
                          description: User information
                        updatedAt:
                          type: string
                          description: Activity last update timestamp
                      required:
                        - id
                        - type
                        - createdAt
                        - updatedAt
                      description: Change request activity
                    description: List of activities
                  snapshot:
                    type: object
                    properties:
                      approvalMode:
                        type: string
                        nullable: true
                        description: Approval mode
                      approvalGroups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Approval group unique identifier
                            name:
                              type: string
                              description: Approval group name
                            description:
                              type: string
                              nullable: true
                              description: Approval group description
                            status:
                              type: string
                              enum:
                                - pending
                                - approved
                              description: Approval group status
                            approvals:
                              type: array
                              items: {}
                              description: List of approvals for this group
                          required:
                            - id
                            - name
                            - status
                            - approvals
                          description: Approval group information
                        description: List of approval groups
                      approvals:
                        type: array
                        items: {}
                        description: List of approvals
                      canComplete:
                        type: boolean
                        description: Whether the change request can be completed
                    description: Change request snapshot containing approval state
                  documentVersion:
                    nullable: true
                    description: Document version being published
                  previousDocumentVersion:
                    nullable: true
                    description: Previous document version
                  previousRelease:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Release unique identifier
                      name:
                        type: string
                        description: Release name
                      version:
                        type: string
                        nullable: true
                        description: Release version
                    required:
                      - id
                      - name
                    description: Release information
                  previousReleaseId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Previous release unique identifier
                required:
                  - id
                  - type
                  - status
                  - projectId
                  - createdAt
                  - updatedAt
                description: Updated change request with the new activity
      security:
        - personalAccessToken: []
        - internalAuth: []
components:
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      description: Personal access token is obtained through your profile
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````