> ## 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.

# Insert records into an external database table

> Adds rows to one table of a database and returns the inserted data.

Send the `table_name` and a `records` array at the top level of the body, with no wrapper key. Each record is a list of `field` and `value` pairs. The response holds `success`, a `message` and `inserted_data` under `external_database`.

> [!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 /external_databases/{db_name}/insert_records
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:
  /external_databases/{db_name}/insert_records:
    post:
      tags:
        - External databases
      summary: Insert records into an external database table
      description: >-
        Send the `table_name` and a `records` array at the top level of the
        body, with no wrapper key. Each record is a list of `field` and `value`
        pairs. The response holds `success`, a `message` and `inserted_data`
        under `external_database`.
      operationId: external_databases_create_external_database_insert_record
      parameters:
        - name: db_name
          in: path
          required: true
          description: >-
            The database's `name`, as given when it is created, such as
            `acmedb`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                table_name:
                  type: string
                records:
                  type: array
                  items:
                    type: object
                    properties:
                      record:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            value:
                              type: string
                        description: One `field` and `value` pair per column.
                  description: The rows to add.
            example:
              table_name: contacts
              records:
                - record:
                    - field: company
                      value: Example Holdings
      responses:
        '200':
          description: The rows are added; the result under `external_database`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDatabaseInsertResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/insert_records"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "table_name": "contacts",
                "records": [
                  {
                    "record": [
                      {
                        "field": "company",
                        "value": "Example Holdings"
                      }
                    ]
                  }
                ]
              }'
        - lang: python
          label: Python
          source: >
            from exsited import build_client


            client = build_client()


            response =
            client.external_databases.create_external_database_insert_record(
                "acmedb",
                {
                    "table_name": "contacts",
                    "records": [{"record": [{"field": "company", "value": "Example Holdings"}]}],
                },
            )

            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.externalDatabases.createExternalDatabaseInsertRecord('acmedb',
            {
                table_name: 'contacts',
                records: [{record: [{field: 'company', value: 'Example Holdings'}]}],
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: >
            use Exsited\Client\ClientRegistry;


            $client = ClientRegistry::buildClient();


            $response =
            $client->externalDatabases->createExternalDatabaseInsertRecord('acmedb',
            [
                'table_name' => 'contacts',
                'records' => [['record' => [['field' => 'company', 'value' => 'Example Holdings']]]],
            ]);

            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.external_databases.external_databases_dto.ExternalDatabasesDto.ExternalDatabaseInsertRecord;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ExternalDatabaseInsertRecord> response =
            client.externalDatabases().createExternalDatabaseInsertRecord(
                    "acmedb",
                    Map.of(
                            "table_name", "contacts",
                            "records", List.of(
                                    Map.of(
                                            "record", List.of(
                                                    Map.of("field", "company", "value", "Example Holdings"))))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ExternalDatabases.CreateExternalDatabaseInsertRecordAsync(
                "acmedb",
                new Dictionary<string, object?>
                {
                    ["table_name"] = "contacts",
                    ["records"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["record"] = new List<object?>
                            {
                                new Dictionary<string, object?>
                                {
                                    ["field"] = "company",
                                    ["value"] = "Example Holdings",
                                },
                            },
                        },
                    },
                });

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

            final client = buildClient();

            final response = await client.externalDatabases
                .createExternalDatabaseInsertRecord('acmedb', {
                  'table_name': 'contacts',
                  'records': [
                    {
                      'record': [
                        {'field': 'company', 'value': 'Example Holdings'},
                      ],
                    },
                  ],
                });
            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.ExternalDatabases().CreateExternalDatabaseInsertRecord(context.Background(), \"acmedb\", map[string]any{\n\t\"table_name\": \"contacts\",\n\t\"records\": []any{\n\t\tmap[string]any{\n\t\t\t\"record\": []any{\n\t\t\t\tmap[string]any{\n\t\t\t\t\t\"field\": \"company\",\n\t\t\t\t\t\"value\": \"Example Holdings\",\n\t\t\t\t},\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:
    ExternalDatabaseInsertResponse:
      type: object
      properties:
        external_database:
          $ref: '#/components/schemas/ExternalDatabaseInsertResult'
    ExternalDatabaseInsertResult:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        inserted_data:
          type: array
          items:
            type: object
  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.