> ## 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 an action script

> Stores an action script and returns it.

Send the script wrapped in `action_script`. `name` is required and must be unique. To include code, send a `.js` file as `script_file`, with its contents base64 encoded in `content`. If you leave out `display_name`, it defaults to `name`.

> [!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 /action_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:
  /action_scripts:
    post:
      tags:
        - Action scripts
      summary: Create an action script
      description: >-
        Send the script wrapped in `action_script`. `name` is required and must
        be unique. To include code, send a `.js` file as `script_file`, with its
        contents base64 encoded in `content`. If you leave out `display_name`,
        it defaults to `name`.
      operationId: action_scripts_create_action_script
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action_script:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The script's name. Must be unique.
                    display_name:
                      type: string
                      description: Defaults to `name`.
                    description:
                      type: string
                    script_file:
                      type: object
                      properties:
                        content:
                          type: string
                          description: The file's contents, base64 encoded.
                      description: A `.js` file holding the script.
                  required:
                    - name
              required:
                - action_script
            example:
              action_script:
                name: notify-account-manager
                description: Notifies the account manager.
      responses:
        '201':
          description: The new action script, under `action_script`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionScriptResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/action_scripts" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "action_script": {
                  "name": "notify-account-manager",
                  "description": "Notifies the account manager."
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.action_scripts.create_action_script(
                {
                    "action_script": {
                        "name": "notify-account-manager",
                        "description": "Notifies the account manager.",
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.actionScripts.createActionScript({
                action_script: {name: 'notify-account-manager', description: 'Notifies the account manager.'},
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->actionScripts->createActionScript([
                'action_script' => [
                    'name' => 'notify-account-manager',
                    'description' => 'Notifies the account manager.',
                ],
            ]);
            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.action_scripts.action_scripts_dto.ActionScriptsDto.ActionScript;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ActionScript> response =
            client.actionScripts().createActionScript(
                    Map.of(
                            "action_script", Map.of(
                                    "name", "notify-account-manager",
                                    "description", "Notifies the account manager.")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ActionScripts.CreateActionScriptAsync(new Dictionary<string,
            object?>

            {
                ["action_script"] = new Dictionary<string, object?>
                {
                    ["name"] = "notify-account-manager",
                    ["description"] = "Notifies the account manager.",
                },
            });


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

            final client = buildClient();

            final response = await client.actionScripts.createActionScript({
              'action_script': {
                'name': 'notify-account-manager',
                'description': 'Notifies the account manager.',
              },
            });
            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.ActionScripts().CreateActionScript(context.Background(), map[string]any{\n\t\"action_script\": map[string]any{\n\t\t\"name\":        \"notify-account-manager\",\n\t\t\"description\": \"Notifies the account manager.\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ActionScriptResponse:
      type: object
      properties:
        action_script:
          $ref: '#/components/schemas/ActionScript'
    ActionScript:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
          description: The action script's `ascr_` id.
        status:
          type: string
        name:
          type: string
          description: Unique across action scripts.
        display_name:
          type: string
          description: The `name` when none is sent.
        description:
          type:
            - string
            - 'null'
        object_name: {}
        action_name: {}
        created_on:
          type: string
        last_updated_on: {}
        created_by:
          $ref: '#/components/schemas/ActionScriptCreatedBy'
        last_updated_by:
          $ref: '#/components/schemas/ActionScriptLastUpdatedBy'
        href:
          type: string
        activity_logs:
          type: array
          items:
            type: object
          description: Present on the create response only.
    ActionScriptCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    ActionScriptLastUpdatedBy:
      type: object
      properties:
        object:
          type: string
        name:
          type: string
      description: Set once the script is updated.
  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.