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

> Creates a rental asset profile and returns it under `rental_asset_profile`.

Send the profile under `rental_asset_profile`: `name`, `display_name`, `currency` and `rental_asset_profile_sessions`. Each session needs at least one price in `rental_asset_profile_session_prices`; a session without one is refused with `400`.

> [!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_asset_profiles
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_asset_profiles:
    post:
      tags:
        - Rental assets
      summary: Create a rental asset profile
      description: >-
        Send the profile under `rental_asset_profile`: `name`, `display_name`,
        `currency` and `rental_asset_profile_sessions`. Each session needs at
        least one price in `rental_asset_profile_session_prices`; a session
        without one is refused with `400`.
      operationId: rental_assets_create_rental_asset_profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - rental_asset_profile
              properties:
                rental_asset_profile:
                  type: object
                  properties:
                    name:
                      type: string
                    display_name:
                      type: string
                    currency:
                      type: string
                      example: AUD
                    rental_asset_profile_sessions:
                      type: array
                      items:
                        type: object
                        required:
                          - rental_asset_profile_session_prices
                        properties:
                          name:
                            type: string
                          start_date:
                            type: string
                            format: date
                          end_date:
                            type: string
                            format: date
                          rental_asset_profile_session_prices:
                            type: array
                            description: A session without a price is refused with `400`.
                            items:
                              type: object
                              properties:
                                price:
                                  type: number
                                price_type:
                                  type: string
                                  example: DAILY
                                enabled_pro_rata:
                                  type: boolean
                          rental_asset_profile_session_availability:
                            type: array
                            items:
                              type: object
                              properties:
                                preferred_day:
                                  type: string
                                  example: Monday
                                available:
                                  type: boolean
                                start_time:
                                  type: string
                                  example: '09:00'
                                end_time:
                                  type: string
                                  example: '17:00'
            example:
              rental_asset_profile:
                name: Standard daily rate
                display_name: Standard daily rate
                currency: AUD
                rental_asset_profile_sessions:
                  - name: Spring season
                    start_date: '2026-11-02'
                    end_date: '2026-12-30'
                    rental_asset_profile_session_prices:
                      - price: 1
                        price_type: DAILY
                        enabled_pro_rata: false
                    rental_asset_profile_session_availability:
                      - preferred_day: Monday
                        available: true
                        start_time: '09:00'
                        end_time: '17:00'
      responses:
        '201':
          description: The new profile, under `rental_asset_profile`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RentalAssetProfileResponse'
        '400':
          description: A session has no price.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/rental_asset_profiles" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "rental_asset_profile": {
                  "name": "Standard daily rate",
                  "display_name": "Standard daily rate",
                  "currency": "AUD",
                  "rental_asset_profile_sessions": [
                    {
                      "name": "Spring season",
                      "start_date": "2026-11-02",
                      "end_date": "2026-12-30",
                      "rental_asset_profile_session_prices": [
                        {
                          "price": 1.0,
                          "price_type": "DAILY",
                          "enabled_pro_rata": false
                        }
                      ],
                      "rental_asset_profile_session_availability": [
                        {
                          "preferred_day": "Monday",
                          "available": true,
                          "start_time": "09:00",
                          "end_time": "17:00"
                        }
                      ]
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.rental_assets.create_rental_asset_profile(
                {
                    "rental_asset_profile": {
                        "name": "Standard daily rate",
                        "display_name": "Standard daily rate",
                        "currency": "AUD",
                        "rental_asset_profile_sessions": [
                            {
                                "name": "Spring season",
                                "start_date": "2026-11-02",
                                "end_date": "2026-12-30",
                                "rental_asset_profile_session_prices": [
                                    {"price": 1.0, "price_type": "DAILY", "enabled_pro_rata": False}
                                ],
                                "rental_asset_profile_session_availability": [
                                    {
                                        "preferred_day": "Monday",
                                        "available": True,
                                        "start_time": "09:00",
                                        "end_time": "17:00",
                                    }
                                ],
                            }
                        ],
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.rentalAssets.createRentalAssetProfile({
                rental_asset_profile: {
                    name: 'Standard daily rate',
                    display_name: 'Standard daily rate',
                    currency: 'AUD',
                    rental_asset_profile_sessions: [
                        {
                            name: 'Spring season',
                            start_date: '2026-11-02',
                            end_date: '2026-12-30',
                            rental_asset_profile_session_prices: [{price: 1.0, price_type: 'DAILY', enabled_pro_rata: false}],
                            rental_asset_profile_session_availability: [
                                {preferred_day: 'Monday', available: true, start_time: '09:00', end_time: '17:00'},
                            ],
                        },
                    ],
                },
            });

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

            $client = ClientRegistry::buildClient();

            $response = $client->rentalAssets->createRentalAssetProfile([
                'rental_asset_profile' => [
                    'name' => 'Standard daily rate',
                    'display_name' => 'Standard daily rate',
                    'currency' => 'AUD',
                    'rental_asset_profile_sessions' => [
                        [
                            'name' => 'Spring season',
                            'start_date' => '2026-11-02',
                            'end_date' => '2026-12-30',
                            'rental_asset_profile_session_prices' => [
                                ['price' => 1.0, 'price_type' => 'DAILY', 'enabled_pro_rata' => false],
                            ],
                            'rental_asset_profile_session_availability' => [
                                [
                                    'preferred_day' => 'Monday',
                                    'available' => true,
                                    'start_time' => '09:00',
                                    'end_time' => '17:00',
                                ],
                            ],
                        ],
                    ],
                ],
            ]);
            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.RentalAssetProfileView;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<RentalAssetProfileView> response =
            client.rentalAssets().createRentalAssetProfile(
                    Map.of(
                            "rental_asset_profile", Map.of(
                                    "name", "Standard daily rate",
                                    "display_name", "Standard daily rate",
                                    "currency", "AUD",
                                    "rental_asset_profile_sessions", List.of(
                                            Map.of(
                                                    "name", "Spring season",
                                                    "start_date", "2026-11-02",
                                                    "end_date", "2026-12-30",
                                                    "rental_asset_profile_session_prices", List.of(
                                                            Map.of(
                                                                    "price", 1.0,
                                                                    "price_type", "DAILY",
                                                                    "enabled_pro_rata", false)),
                                                    "rental_asset_profile_session_availability", List.of(
                                                            Map.of(
                                                                    "preferred_day", "Monday",
                                                                    "available", true,
                                                                    "start_time", "09:00",
                                                                    "end_time", "17:00")))))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


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

            {
                ["rental_asset_profile"] = new Dictionary<string, object?>
                {
                    ["name"] = "Standard daily rate",
                    ["display_name"] = "Standard daily rate",
                    ["currency"] = "AUD",
                    ["rental_asset_profile_sessions"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["name"] = "Spring season",
                            ["start_date"] = "2026-11-02",
                            ["end_date"] = "2026-12-30",
                            ["rental_asset_profile_session_prices"] = new List<object?>
                            {
                                new Dictionary<string, object?>
                                {
                                    ["price"] = 1.0,
                                    ["price_type"] = "DAILY",
                                    ["enabled_pro_rata"] = false,
                                },
                            },
                            ["rental_asset_profile_session_availability"] = new List<object?>
                            {
                                new Dictionary<string, object?>
                                {
                                    ["preferred_day"] = "Monday",
                                    ["available"] = true,
                                    ["start_time"] = "09:00",
                                    ["end_time"] = "17:00",
                                },
                            },
                        },
                    },
                },
            });


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


            final client = buildClient();


            final response = await
            client.rentalAssets.createRentalAssetProfile({
              'rental_asset_profile': {
                'name': 'Standard daily rate',
                'display_name': 'Standard daily rate',
                'currency': 'AUD',
                'rental_asset_profile_sessions': [
                  {
                    'name': 'Spring season',
                    'start_date': '2026-11-02',
                    'end_date': '2026-12-30',
                    'rental_asset_profile_session_prices': [
                      {'price': 1.0, 'price_type': 'DAILY', 'enabled_pro_rata': false},
                    ],
                    'rental_asset_profile_session_availability': [
                      {
                        'preferred_day': 'Monday',
                        'available': true,
                        'start_time': '09:00',
                        'end_time': '17:00',
                      },
                    ],
                  },
                ],
              },
            });

            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().CreateRentalAssetProfile(context.Background(), map[string]any{\n\t\"rental_asset_profile\": map[string]any{\n\t\t\"name\":         \"Standard daily rate\",\n\t\t\"display_name\": \"Standard daily rate\",\n\t\t\"currency\":     \"AUD\",\n\t\t\"rental_asset_profile_sessions\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"name\":       \"Spring season\",\n\t\t\t\t\"start_date\": \"2026-11-02\",\n\t\t\t\t\"end_date\":   \"2026-12-30\",\n\t\t\t\t\"rental_asset_profile_session_prices\": []any{\n\t\t\t\t\tmap[string]any{\n\t\t\t\t\t\t\"price\":            1.0,\n\t\t\t\t\t\t\"price_type\":       \"DAILY\",\n\t\t\t\t\t\t\"enabled_pro_rata\": false,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\"rental_asset_profile_session_availability\": []any{\n\t\t\t\t\tmap[string]any{\n\t\t\t\t\t\t\"preferred_day\": \"Monday\",\n\t\t\t\t\t\t\"available\":     true,\n\t\t\t\t\t\t\"start_time\":    \"09:00\",\n\t\t\t\t\t\t\"end_time\":      \"17:00\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    RentalAssetProfileResponse:
      type: object
      required:
        - rental_asset_profile
      properties:
        rental_asset_profile:
          $ref: '#/components/schemas/RentalAssetProfileView'
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                type: string
    RentalAssetProfileView:
      type: object
      properties:
        activity_logs:
          type: array
        created_by:
          $ref: '#/components/schemas/RentalAssetProfileViewCreatedBy'
        created_on:
          type: string
        currency:
          $ref: '#/components/schemas/RentalAssetProfileViewCurrency'
        display_name:
          type: string
        href:
          type: string
        id:
          type: string
        is_tax_inclusive:
          type: boolean
        last_updated_by:
          $ref: '#/components/schemas/RentalAssetProfileViewLastUpdatedBy'
        last_updated_on:
          type: string
        max_booking_limit:
          type: 'null'
          description: Returned as `null`.
        name:
          type: string
        object:
          type: string
        rental_asset_profile_sessions:
          type: array
          items:
            $ref: >-
              #/components/schemas/RentalAssetProfileViewRentalAssetProfileSession
        rental_assets:
          type: array
          items:
            $ref: '#/components/schemas/RentalAssetProfileViewRow'
        status:
          type: string
        tax:
          type: 'null'
          description: Returned as `null`.
        version:
          type: integer
    RentalAssetProfileViewCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    RentalAssetProfileViewCurrency:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    RentalAssetProfileViewLastUpdatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    RentalAssetProfileViewRentalAssetProfileSession:
      type: object
      properties:
        end_date:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        rental_asset_profile_session_availability:
          type: array
          items:
            $ref: >-
              #/components/schemas/RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionAvailability
        rental_asset_profile_session_prices:
          type: array
          items:
            $ref: >-
              #/components/schemas/RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionPrice
        rental_asset_profile_session_working_hours:
          type: array
          items:
            $ref: >-
              #/components/schemas/RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionWorkingHour
        start_date:
          type: string
        status:
          type: string
    RentalAssetProfileViewRow:
      type: object
      properties:
        display_name:
          type: string
        href:
          type: string
        id:
          type: string
        image_name:
          type: 'null'
          description: Returned as `null`.
        name:
          type: string
        object:
          type: string
        status:
          type: string
        use_custom_availability:
          type: boolean
    RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionAvailability:
      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
    RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionPrice:
      type: object
      properties:
        id:
          type: string
        is_enabled_pro_rata:
          type: boolean
        object:
          type: string
        price:
          type: number
        price_type:
          type: string
        pricing_level:
          type: 'null'
          description: Returned as `null`.
        rental_asset_profile_session_price_hours:
          type: array
        rental_asset_profile_session_price_peak_hourly:
          type: array
        status:
          type: string
    RentalAssetProfileViewRentalAssetProfileSessionRentalAssetProfileSessionWorkingHour:
      type: object
      properties:
        end_time:
          type: string
        id:
          type: string
        object:
          type: string
        start_time:
          type: string
        status:
          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.