> ## 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 custom form

> Creates a custom form and returns it, under `custom_form`.

Creates a new custom form. Send `name` and `setting_group`, a setting group name such as `ACCOUNT`, under `custom_form`. The new form comes back with its `cf_` id.

> [!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 /settings/custom_forms
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:
  /settings/custom_forms:
    post:
      tags:
        - Custom forms
      summary: Create a custom form
      description: >-
        Creates a new custom form. Send `name` and `setting_group`, a setting
        group name such as `ACCOUNT`, under `custom_form`. The new form comes
        back with its `cf_` id.
      operationId: custom_forms_create_settings_custom_form
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_form:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The form's name.
                    setting_group:
                      type: string
                      description: >-
                        The setting group the form belongs to, such as
                        `ACCOUNT`.
                    display_name:
                      type: string
                    description:
                      type: string
                  required:
                    - name
                    - setting_group
              required:
                - custom_form
            example:
              custom_form:
                name: acme-account-form
                setting_group: ACCOUNT
      responses:
        '201':
          description: The new custom form, under `custom_form`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/settings/custom_forms" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "custom_form": {
                  "name": "acme-account-form",
                  "setting_group": "ACCOUNT"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.custom_forms.create_settings_custom_form(
                {"custom_form": {"name": "acme-account-form", "setting_group": "ACCOUNT"}}
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.customForms.createSettingsCustomForm({
                custom_form: {name: 'acme-account-form', setting_group: 'ACCOUNT'},
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->customForms->createSettingsCustomForm([
                'custom_form' => ['name' => 'acme-account-form', 'setting_group' => 'ACCOUNT'],
            ]);
            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.custom_forms.custom_forms_dto.CustomFormsDto.SettingsCustomForm;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<SettingsCustomForm> response =
            client.customForms().createSettingsCustomForm(
                    Map.of("custom_form", Map.of("name", "acme-account-form", "setting_group", "ACCOUNT")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.CustomForms.CreateSettingsCustomFormAsync(new
            Dictionary<string, object?>

            {
                ["custom_form"] = new Dictionary<string, object?>
                {
                    ["name"] = "acme-account-form",
                    ["setting_group"] = "ACCOUNT",
                },
            });


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

            final client = buildClient();

            final response = await client.customForms.createSettingsCustomForm({
              'custom_form': {'name': 'acme-account-form', 'setting_group': 'ACCOUNT'},
            });
            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.CustomForms().CreateSettingsCustomForm(context.Background(), map[string]any{\n\t\"custom_form\": map[string]any{\n\t\t\"name\":          \"acme-account-form\",\n\t\t\"setting_group\": \"ACCOUNT\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    CustomFormResponse:
      type: object
      properties:
        custom_form:
          $ref: '#/components/schemas/CustomForm'
    CustomForm:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        status:
          type: string
        name:
          type: string
        display_name:
          type: string
        description:
          type: string
        is_system_template:
          type: boolean
          description: >-
            Whether the form is system generated. A system generated form cannot
            be deleted.
        for_default_template:
          type: boolean
        created_on:
          type: string
        last_updated_on:
          type: string
        created_by: {}
        last_updated_by: {}
        href:
          type: string
  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.