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

# Create a note group

> Creates a note group and returns it.

Send the group wrapped in `note_group`, with a `name` and, optionally, `note_users` to add. The new group comes back under `note_group`, with its `activity_logs`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /note_groups
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /note_groups:
    post:
      tags:
        - Note groups
      summary: Create a note group
      description: >-
        Send the group wrapped in `note_group`, with a `name` and, optionally,
        `note_users` to add. The new group comes back under `note_group`, with
        its `activity_logs`.
      operationId: note_groups_create_note_group
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                note_group:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The group's name.
                    note_users:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          email_address:
                            type: string
                      description: Users to add to the group.
              required:
                - note_group
            example:
              note_group:
                name: Project team
                note_users:
                  - name: Jane Citizen
                    email_address: jane@example.com
      responses:
        '201':
          description: The new note group, under `note_group`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteGroupResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/note_groups" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "note_group": {
                  "name": "Project team",
                  "note_users": [
                    {
                      "name": "Jane Citizen",
                      "email_address": "jane@example.com"
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.note_groups.create_note_group(
                {
                    "note_group": {
                        "name": "Project team",
                        "note_users": [
                            {"name": "Jane Citizen", "email_address": "jane@example.com"}
                        ],
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.noteGroups.createNoteGroup({
                note_group: {name: 'Project team', note_users: [{name: 'Jane Citizen', email_address: 'jane@example.com'}]},
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->noteGroups->createNoteGroup([
                'note_group' => [
                    'name' => 'Project team',
                    'note_users' => [['name' => 'Jane Citizen', 'email_address' => 'jane@example.com']],
                ],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.note_groups.note_groups_dto.NoteGroupsDto.NoteGroup;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<NoteGroup> response =
            client.noteGroups().createNoteGroup(
                    Map.of(
                            "note_group", Map.of(
                                    "name", "Project team",
                                    "note_users", List.of(
                                            Map.of("name", "Jane Citizen", "email_address", "jane@example.com")))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await client.NoteGroups.CreateNoteGroupAsync(new
            Dictionary<string, object?>

            {
                ["note_group"] = new Dictionary<string, object?>
                {
                    ["name"] = "Project team",
                    ["note_users"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["name"] = "Jane Citizen",
                            ["email_address"] = "jane@example.com",
                        },
                    },
                },
            });


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.noteGroups.createNoteGroup({
              'note_group': {
                'name': 'Project team',
                'note_users': [
                  {'name': 'Jane Citizen', 'email_address': 'jane@example.com'},
                ],
              },
            });
            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.NoteGroups().CreateNoteGroup(context.Background(), map[string]any{\n\t\"note_group\": map[string]any{\n\t\t\"name\": \"Project team\",\n\t\t\"note_users\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"name\":          \"Jane Citizen\",\n\t\t\t\t\"email_address\": \"jane@example.com\",\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    NoteGroupResponse:
      type: object
      properties:
        note_group:
          $ref: '#/components/schemas/NoteGroup'
    NoteGroup:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
          description: The note group's id.
        status:
          type: string
        name:
          type: string
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        created_on:
          type: string
        last_updated_on:
          type:
            - string
            - 'null'
        created_by: {}
        last_updated_by: {}
        version:
          type: integer
          description: 'Counts changes: after one update a new group reads `2`.'
        href:
          type: string
        activity_logs:
          type: array
          items:
            type: object
          description: Present on create and update responses.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.