> ## 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 rental asset

> Creates a rental asset and returns it under `rental_asset`.

Send the asset under `rental_asset` with its `name` and the `id` of its `rental_asset_profile`.

> [!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 /rental_assets
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:
  /rental_assets:
    post:
      tags:
        - Rental assets
      summary: Create a rental asset
      description: >-
        Send the asset under `rental_asset` with its `name` and the `id` of its
        `rental_asset_profile`.
      operationId: rental_assets_create_rental_asset
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - rental_asset
              properties:
                rental_asset:
                  type: object
                  properties:
                    name:
                      type: string
                    rental_asset_profile:
                      type: string
                      description: The rental asset profile's `id`.
            example:
              rental_asset:
                name: Projector 1
                rental_asset_profile: RENTAL_ASSET_PROFILE_ID
      responses:
        '201':
          description: The new rental asset, under `rental_asset`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RentalAssetResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/rental_assets" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "rental_asset": {
                  "name": "Projector 1",
                  "rental_asset_profile": "RENTAL_ASSET_PROFILE_ID"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.rental_assets.create_rental_asset(
                {
                    "rental_asset": {
                        "name": "Projector 1",
                        "rental_asset_profile": "RENTAL_ASSET_PROFILE_ID",
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.rentalAssets.createRentalAsset({
                rental_asset: {name: 'Projector 1', rental_asset_profile: 'RENTAL_ASSET_PROFILE_ID'},
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->rentalAssets->createRentalAsset([
                'rental_asset' => ['name' => 'Projector 1', 'rental_asset_profile' => 'RENTAL_ASSET_PROFILE_ID'],
            ]);
            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.rental_assets.rental_assets_dto.RentalAssetsDto.RentalAsset;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<RentalAsset> response =
            client.rentalAssets().createRentalAsset(
                    Map.of(
                            "rental_asset", Map.of(
                                    "name", "Projector 1",
                                    "rental_asset_profile", "RENTAL_ASSET_PROFILE_ID")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await client.RentalAssets.CreateRentalAssetAsync(new
            Dictionary<string, object?>

            {
                ["rental_asset"] = new Dictionary<string, object?>
                {
                    ["name"] = "Projector 1",
                    ["rental_asset_profile"] = "RENTAL_ASSET_PROFILE_ID",
                },
            });


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

            final client = buildClient();

            final response = await client.rentalAssets.createRentalAsset({
              'rental_asset': {
                'name': 'Projector 1',
                'rental_asset_profile': 'RENTAL_ASSET_PROFILE_ID',
              },
            });
            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.RentalAssets().CreateRentalAsset(context.Background(), map[string]any{\n\t\"rental_asset\": map[string]any{\n\t\t\"name\":                 \"Projector 1\",\n\t\t\"rental_asset_profile\": \"RENTAL_ASSET_PROFILE_ID\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    RentalAssetResponse:
      type: object
      required:
        - rental_asset
      properties:
        rental_asset:
          $ref: '#/components/schemas/RentalAsset'
    RentalAsset:
      type: object
      properties:
        activity_logs:
          type: array
        code:
          type: string
        created_by:
          $ref: '#/components/schemas/RentalAssetCreatedBy'
        created_on:
          type: string
        custom_attributes:
          type: array
        custom_form:
          $ref: '#/components/schemas/RentalAssetCustomForm'
        description:
          type: string
        display_name:
          type: string
        href:
          type: string
        id:
          type: string
        image_name:
          type: 'null'
          description: Returned as `null`.
        item:
          type: 'null'
          description: Returned as `null`.
        last_updated_by:
          $ref: '#/components/schemas/RentalAssetLastUpdatedBy'
        last_updated_on:
          type: string
        name:
          type: string
        object:
          type: string
        rental_asset_availability:
          type: array
        rental_asset_custom_availability:
          type: array
          items:
            $ref: '#/components/schemas/RentalAssetRentalAssetCustomAvailability'
        rental_asset_profile:
          $ref: '#/components/schemas/RentalAssetRentalAssetProfile'
        status:
          type: string
        use_custom_availability:
          type: boolean
        version:
          type: integer
    RentalAssetCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    RentalAssetCustomForm:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    RentalAssetLastUpdatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    RentalAssetRentalAssetCustomAvailability:
      type: object
      properties:
        available:
          type: boolean
        end_time:
          type: string
        id:
          type: string
        object:
          type: string
        preferred_day:
          type: string
        start_time:
          type: string
        status:
          type: string
    RentalAssetRentalAssetProfile:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          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.