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

> Creates an object in a component and returns it, under `custom_component_object`.

Creates a new object in the component with this `cmp_` id. Send its fields under `custom_component_object`; every key is optional, and `parents` names the record that owns it, such as an account. The new object comes back with its `id` and `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 /components/{component_uuid}/objects
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:
  /components/{component_uuid}/objects:
    post:
      tags:
        - Custom components
      summary: Create a component object
      description: >-
        Creates a new object in the component with this `cmp_` id. Send its
        fields under `custom_component_object`; every key is optional, and
        `parents` names the record that owns it, such as an account. The new
        object comes back with its `id` and `activity_logs`.
      operationId: custom_components_create_component_object
      parameters:
        - name: component_uuid
          in: path
          required: true
          description: The component definition's `id`, which starts with `cmp_`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_component_object:
                  type: object
                  properties:
                    parents:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: The owner's type, such as `account`.
                          id:
                            type: string
                            description: The owner's `id`.
                        required:
                          - type
                          - id
                      description: The record that owns the object, such as an account.
                    attributes:
                      type: array
                      items:
                        type: object
              required:
                - custom_component_object
            example:
              custom_component_object:
                parents:
                  - type: account
                    id: ACC0001
      responses:
        '201':
          description: The new component object, under `custom_component_object`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentObjectRecordResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "custom_component_object": {
                  "parents": [
                    {
                      "type": "account",
                      "id": "ACC0001"
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.custom_components.create_component_object(
                "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
                {"custom_component_object": {"parents": [{"type": "account", "id": "ACC0001"}]}},
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.customComponents.createComponentObject('cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
            {
                custom_component_object: {parents: [{type: 'account', id: 'ACC0001'}]},
            });

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

            $client = ClientRegistry::buildClient();

            $response = $client->customComponents->createComponentObject(
                'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
                ['custom_component_object' => ['parents' => [['type' => 'account', 'id' => 'ACC0001']]]],
            );
            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_components.custom_components_dto.CustomComponentsDto.ComponentObjectRecord;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ComponentObjectRecord> response =
            client.customComponents().createComponentObject(
                    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
                    Map.of(
                            "custom_component_object", Map.of(
                                    "parents", List.of(Map.of("type", "account", "id", "ACC0001")))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.CustomComponents.CreateComponentObjectAsync(
                "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
                new Dictionary<string, object?>
                {
                    ["custom_component_object"] = new Dictionary<string, object?>
                    {
                        ["parents"] = new List<object?>
                        {
                            new Dictionary<string, object?>
                            {
                                ["type"] = "account",
                                ["id"] = "ACC0001",
                            },
                        },
                    },
                });

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


            final client = buildClient();


            final response = await
            client.customComponents.createComponentObject(
              'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
              {
                'custom_component_object': {
                  'parents': [
                    {'type': 'account', 'id': 'ACC0001'},
                  ],
                },
              },
            );

            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.CustomComponents().CreateComponentObject(context.Background(), \"cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d\", map[string]any{\n\t\"custom_component_object\": map[string]any{\n\t\t\"parents\": []any{\n\t\t\tmap[string]any{\"type\": \"account\", \"id\": \"ACC0001\"},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ComponentObjectRecordResponse:
      type: object
      properties:
        custom_component_object:
          $ref: '#/components/schemas/ComponentObjectRecord'
    ComponentObjectRecord:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        status:
          type: string
        code:
          type: string
        component:
          $ref: '#/components/schemas/ComponentObjectComponent'
        custom_form:
          $ref: '#/components/schemas/ComponentObjectCustomForm'
        attributes:
          type: array
          items:
            type: object
        attribute_groups:
          type: array
          items:
            type: object
        restrictions:
          type: array
          items:
            type: object
        parents:
          type: array
          items:
            $ref: '#/components/schemas/ComponentObjectParent'
        workflow_status: {}
        workflow_status_uuid: {}
        workflow_stage: {}
        workflow_data:
          type: array
          items:
            type: object
        custom_objects:
          type: array
          items:
            type: object
        accounts:
          type: array
          items:
            type: object
        items:
          type: array
          items:
            type: object
        orders:
          type: array
          items:
            type: object
        quotes:
          type: array
          items:
            type: object
        created_on:
          type: string
        last_updated_on:
          type:
            - string
            - 'null'
        created_by: {}
        last_updated_by: {}
        version:
          type: integer
        href:
          type: string
        activity_logs:
          type: array
          items:
            $ref: '#/components/schemas/ComponentObjectActivityLog'
    ComponentObjectComponent:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    ComponentObjectCustomForm:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        object:
          type: string
    ComponentObjectParent:
      type: object
      properties:
        email:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        type:
          type: string
    ComponentObjectActivityLog:
      type: object
      properties:
        activity:
          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.