> ## 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 object instance

> Creates an instance of a custom object on an account.

Name the custom object by its `co_` id and send the instance under `custom_object_instances`. `attributes` must be a list of `name` and `value` pairs. The new instance comes back under `custom_object_instance`.

> [!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 /accounts/{account_id}/custom_objects/{custom_object_id}
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:
  /accounts/{account_id}/custom_objects/{custom_object_id}:
    post:
      tags:
        - Accounts
      summary: Create a custom object instance
      description: >-
        Name the custom object by its `co_` id and send the instance under
        `custom_object_instances`. `attributes` must be a list of `name` and
        `value` pairs. The new instance comes back under
        `custom_object_instance`.
      operationId: accounts_create_account_custom_object_instance
      parameters:
        - name: account_id
          in: path
          required: true
          description: The account's `id`, such as `ACC0001`. Not its `uuid`.
          schema:
            type: string
        - name: custom_object_id
          in: path
          required: true
          description: The custom object's `co_` id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - custom_object_instances
              properties:
                custom_object_instances:
                  type: object
                  properties:
                    attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value: {}
                      description: The instance's values, as `name` and `value` pairs.
            example:
              custom_object_instances:
                attributes:
                  - name: ATTRIBUTE_NAME
                    value: Example value
      responses:
        '200':
          description: The new instance, under `custom_object_instance`.
        '400':
          description: The body holds a key this call does not accept; the error names it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/custom_objects/co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "custom_object_instances": {
                  "attributes": [
                    {
                      "name": "ATTRIBUTE_NAME",
                      "value": "Example value"
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.accounts.create_account_custom_object_instance(
                "ACC0001",
                "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
                {
                    "custom_object_instances": {
                        "attributes": [{"name": "ATTRIBUTE_NAME", "value": "Example value"}]
                    }
                },
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.accounts.createAccountCustomObjectInstance(
                'ACC0001',
                'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
                {custom_object_instances: {attributes: [{name: 'ATTRIBUTE_NAME', value: 'Example value'}]}},
            );

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

            $client = ClientRegistry::buildClient();

            $response = $client->accounts->createAccountCustomObjectInstance(
                'ACC0001',
                'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
                [
                    'custom_object_instances' => [
                        'attributes' => [['name' => 'ATTRIBUTE_NAME', 'value' => 'Example value']],
                    ],
                ],
            );
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.Dto;

            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<Dto> response =
            client.accounts().createAccountCustomObjectInstance(
                    "ACC0001",
                    "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
                    Map.of(
                            "custom_object_instances", Map.of(
                                    "attributes", List.of(
                                            Map.of("name", "ATTRIBUTE_NAME", "value", "Example value")))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Accounts.CreateAccountCustomObjectInstanceAsync(
                "ACC0001",
                "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
                new Dictionary<string, object?>
                {
                    ["custom_object_instances"] = new Dictionary<string, object?>
                    {
                        ["attributes"] = new List<object?>
                        {
                            new Dictionary<string, object?>
                            {
                                ["name"] = "ATTRIBUTE_NAME",
                                ["value"] = "Example value",
                            },
                        },
                    },
                });

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


            final client = buildClient();


            final response = await
            client.accounts.createAccountCustomObjectInstance(
              'ACC0001',
              'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
              {
                'custom_object_instances': {
                  'attributes': [
                    {'name': 'ATTRIBUTE_NAME', 'value': 'Example value'},
                  ],
                },
              },
            );

            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.Accounts().CreateAccountCustomObjectInstance(context.Background(), \"ACC0001\", \"co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b\", map[string]any{\n\t\"custom_object_instances\": map[string]any{\n\t\t\"attributes\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"name\":  \"ATTRIBUTE_NAME\",\n\t\t\t\t\"value\": \"Example value\",\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:
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                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.