> ## 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 logic script

> Creates a custom logic script and returns it under `custom_logic_script`.

Send the new script under `custom_logic_script`. `name`, `type` and `code` are required. The `code` is validated and returned in the response, but it is not stored, so a later read does not return it.

> [!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_logic_scripts
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_logic_scripts:
    post:
      tags:
        - Instance settings
      summary: Create a custom logic script
      description: >-
        Send the new script under `custom_logic_script`. `name`, `type` and
        `code` are required. The `code` is validated and returned in the
        response, but it is not stored, so a later read does not return it.
      operationId: settings_create_settings_custom_logic_script
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_logic_script:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The script's name.
                    type:
                      type: string
                      description: The script type, such as `CUSTOM_EVENT_SCRIPT`.
                    code:
                      type: string
                      description: The script code. It is checked but not stored.
                    status:
                      type: string
                      description: Such as `INACTIVE`.
                  required:
                    - name
                    - type
                    - code
              required:
                - custom_logic_script
            example:
              custom_logic_script:
                name: credit_check
                type: CUSTOM_EVENT_SCRIPT
                code: return true
                status: INACTIVE
      responses:
        '201':
          description: >-
            The new custom logic script, under `custom_logic_script`, with the
            `code` you sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsCustomLogicScriptSavedResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/settings/custom_logic_scripts" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "custom_logic_script": {
                  "name": "credit_check",
                  "type": "CUSTOM_EVENT_SCRIPT",
                  "code": "return true",
                  "status": "INACTIVE"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.settings.create_settings_custom_logic_script(
                {
                    "custom_logic_script": {
                        "name": "credit_check",
                        "type": "CUSTOM_EVENT_SCRIPT",
                        "code": "return true",
                        "status": "INACTIVE",
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.settings.createSettingsCustomLogicScript({
                custom_logic_script: {name: 'credit_check', type: 'CUSTOM_EVENT_SCRIPT', code: 'return true', status: 'INACTIVE'},
            });

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

            $client = ClientRegistry::buildClient();

            $response = $client->settings->createSettingsCustomLogicScript([
                'custom_logic_script' => [
                    'name' => 'credit_check',
                    'type' => 'CUSTOM_EVENT_SCRIPT',
                    'code' => 'return true',
                    'status' => 'INACTIVE',
                ],
            ]);
            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.settings.settings_dto.SettingsDto.SettingsCustomLogicScriptSaved;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<SettingsCustomLogicScriptSaved> response =
            client.settings().createSettingsCustomLogicScript(
                    Map.of(
                            "custom_logic_script", Map.of(
                                    "name", "credit_check",
                                    "type", "CUSTOM_EVENT_SCRIPT",
                                    "code", "return true",
                                    "status", "INACTIVE")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Settings.CreateSettingsCustomLogicScriptAsync(new
            Dictionary<string, object?>

            {
                ["custom_logic_script"] = new Dictionary<string, object?>
                {
                    ["name"] = "credit_check",
                    ["type"] = "CUSTOM_EVENT_SCRIPT",
                    ["code"] = "return true",
                    ["status"] = "INACTIVE",
                },
            });


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


            final client = buildClient();


            final response = await
            client.settings.createSettingsCustomLogicScript({
              'custom_logic_script': {
                'name': 'credit_check',
                'type': 'CUSTOM_EVENT_SCRIPT',
                'code': 'return true',
                'status': 'INACTIVE',
              },
            });

            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.Settings().CreateSettingsCustomLogicScript(context.Background(), map[string]any{\n\t\"custom_logic_script\": map[string]any{\n\t\t\"name\":   \"credit_check\",\n\t\t\"type\":   \"CUSTOM_EVENT_SCRIPT\",\n\t\t\"code\":   \"return true\",\n\t\t\"status\": \"INACTIVE\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    SettingsCustomLogicScriptSavedResponse:
      type: object
      properties:
        custom_logic_script:
          $ref: '#/components/schemas/SettingsCustomLogicScriptSaved'
    SettingsCustomLogicScriptSaved:
      type: object
      properties:
        action_name:
          type: string
        created_by:
          description: Can be null.
        created_on:
          type: string
        description:
          description: Can be null.
        display_name:
          type: string
        href:
          type: string
        id:
          type: string
        last_updated_by:
          description: Can be null.
        last_updated_on:
          type: string
        name:
          type: string
        object:
          type: string
        object_name:
          type: string
        status:
          type: string
        type:
          type: string
        code:
          description: Can be null.
  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.