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

# Update a component instance

> Changes a component instance and returns it under the component's name.

Updates the instance with this `id` in the component with this dashed `uuid`. The body has one key, the component's `name`, holding the fields to change, such as `attributes`. The updated instance comes back under the same key with a new `version`.

> [!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 PATCH /component/{component_uuid}/{component_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:
  /component/{component_uuid}/{component_object_id}:
    patch:
      tags:
        - Custom components
      summary: Update a component instance
      description: >-
        Updates the instance with this `id` in the component with this dashed
        `uuid`. The body has one key, the component's `name`, holding the fields
        to change, such as `attributes`. The updated instance comes back under
        the same key with a new `version`.
      operationId: custom_components_update_component_by_id
      parameters:
        - name: component_uuid
          in: path
          required: true
          description: >-
            The component's dashed `uuid`, not its `cmp_` id. It is the `uuid`
            the component has in the `GET /settings/components` listing.
          schema:
            type: string
        - name: component_object_id
          in: path
          required: true
          description: The component instance's `id`, as returned when it is created.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: One key, the component's `name`, holding the fields to change.
              additionalProperties:
                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
                  attributes:
                    type: array
                    items:
                      type: object
              minProperties: 1
              maxProperties: 1
            example:
              service_contract:
                attributes: []
      responses:
        '202':
          description: The updated instance, under the component's `name`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentInstanceResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "service_contract": {
                  "attributes": []
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.custom_components.update_component_by_id(
                "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
                "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
                {"service_contract": {"attributes": []}},
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.customComponents.updateComponentById(
                '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
                'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
                {service_contract: {attributes: []}},
            );
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->customComponents->updateComponentById(
                '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
                'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
                ['service_contract' => ['attributes' => []]],
            );
            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.ComponentByUuid;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ComponentByUuid> response =
            client.customComponents().updateComponentById(
                    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
                    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
                    Map.of("service_contract", Map.of("attributes", List.of())));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.CustomComponents.UpdateComponentByIdAsync(
                "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
                "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
                new Dictionary<string, object?>
                {
                    ["service_contract"] = new Dictionary<string, object?>
                    {
                        ["attributes"] = new List<object?>(),
                    },
                });

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

            final client = buildClient();

            final response = await client.customComponents.updateComponentById(
              '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
              'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
              {
                'service_contract': {'attributes': []},
              },
            );
            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().UpdateComponentByID(context.Background(), \"5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b\", \"a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e\", map[string]any{\n\t\"service_contract\": map[string]any{\"attributes\": []any{}},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ComponentInstanceResponse:
      type: object
      description: One key, the component's `name`, holding the instance.
      additionalProperties:
        $ref: '#/components/schemas/ComponentInstance'
    ComponentInstance:
      type: object
      properties:
        status:
          type: string
        id:
          type: string
        uuid:
          type: string
        parents:
          type: array
          items:
            type: object
        custom_form:
          type: object
        attributes:
          type: array
          items:
            type: object
        attribute_groups:
          type: array
          items:
            type: object
        custom_objects:
          type: array
          items:
            type: object
        restrictions:
          type: array
          items:
            type: object
        activity_logs:
          type: array
          items:
            type: object
        created_by:
          type: string
        created_on:
          type: string
        last_updated_by:
          type: string
        last_updated_on:
          type: string
        version:
          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.