> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # CreateResource # Package: resources # Namespace: ResourcesService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/create-resource.md ## Permission Scopes: Manage Bookings: SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS ## Introduction Creates a new resource. --- ## REST API ### Schema ``` Method: createResource Description: Creates a new resource. ### Connected schedules A new event [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/wix-bookings-integration.md) is automatically created for the resource. ### Locations If you don't specify `locationOptions`, Wix Bookings automatically sets `locationOptions.availableInAllLocations` to `true`. If you specify 1 business location GUID in `locationOptions.specificLocationOptions.businessLocations`, you must specify `locationOptions.specificLocationOptions.availableInBusinessLocations` as `true`. Currently, you can specify only a single business location. URL: https://www.wixapis.com/bookings/v2/resources Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: resource, resource.name Method parameters: param name: resource | type: Resource | description: A resource represents an entity, such as a room or a staff member, that can be scheduled for use in a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/about-the-bookings-apis.md). The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings. | required: true - name: name | type: string | description: Name of the resource. | required: true - name: typeId | type: string | description: GUID of the [resource type](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md). Once a type has been set it can't be modified. You can create a resource without specifying a type. However, customers can't book such resources. - name: workingHoursSchedules | type: WorkingHoursSchedules | description: Information about the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) specifying the working hours and locations of the resource. Resources without a working hour schedule are available 24/7 at the locations specified in the field `locationOptions`. When both `workingHoursSchedules` and `locationOptions` are set, `workingHoursSchedules` takes precedence. - name: values | type: array | description: Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. - name: scheduleId | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: locationOptions | type: LocationOptions | description: Information about the location where the resource is available. - name: availableInAllLocations | type: boolean | description: Whether the resource is available in all [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in all business locations. - `false`: The resource is available only in specific locations. Default: `false` - name: specificLocationOptions | type: SpecificLocation | description: Details of resource availability in specific locations. - name: availableInBusinessLocations | type: boolean | description: Whether the resource is available in [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in business locations. - `false`: The resource isn't available in business locations. Default: `false` - name: businessLocations | type: array | description: Information about the business locations where the resource is available. Not returned, if the resource is available in either all business locations or in no business location. You can specify up to 100 business locations. - name: locationId | type: string | description: GUID of the business [location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the resource. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: CreateResourceResponse - name: resource | type: Resource | description: Created resource. - name: id | type: string | description: Resource GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the resource is updated. To prevent conflicting changes, the current revision must be passed when updating the resource. - name: createdDate | type: string | description: Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was created. - name: updatedDate | type: string | description: Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was last updated. - name: name | type: string | description: Name of the resource. - name: typeId | type: string | description: GUID of the [resource type](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md). Once a type has been set it can't be modified. You can create a resource without specifying a type. However, customers can't book such resources. - name: workingHoursSchedules | type: WorkingHoursSchedules | description: Information about the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) specifying the working hours and locations of the resource. Resources without a working hour schedule are available 24/7 at the locations specified in the field `locationOptions`. When both `workingHoursSchedules` and `locationOptions` are set, `workingHoursSchedules` takes precedence. - name: values | type: array | description: Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. - name: scheduleId | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: shared | type: boolean | description: Whether the schedule is shared by multiple resources or unique for this resource. Default: `false` - name: locationOptions | type: LocationOptions | description: Information about the location where the resource is available. - name: availableInAllLocations | type: boolean | description: Whether the resource is available in all [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in all business locations. - `false`: The resource is available only in specific locations. Default: `false` - name: specificLocationOptions | type: SpecificLocation | description: Details of resource availability in specific locations. - name: availableInBusinessLocations | type: boolean | description: Whether the resource is available in [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in business locations. - `false`: The resource isn't available in business locations. Default: `false` - name: businessLocations | type: array | description: Information about the business locations where the resource is available. Not returned, if the resource is available in either all business locations or in no business location. You can specify up to 100 business locations. - name: locationId | type: string | description: GUID of the business [location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: eventsSchedule | type: EventsSchedule | description: Schedule containing the [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) for which the resource has been booked. - name: scheduleId | type: string | description: GUID of the event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the resource. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_AVAILABLE_IN_BUSINESS_LOCATION_MUST_BE_TRUE | Description: `availableInBusinessLocations` must be set to `true`. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_SPECIFIC_LOCATION_OPTIONS_MUST_BE_SET | Description: `specificLocationOptions` must be set when `availableInAllLocations` is set to `false` or empty. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_SPECIFIC_LOCATION_OPTIONS_NOT_ALLOWED | Description: `specificLocationOptions` can't be set when `availableInAllLocations` is set to `true`. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_LOCATION_ID_IS_REQUIRED | Description: Business location GUID is required. ``` ### Examples ### Create a resource. This is a more extensive example where a resource is created that is available at a specific business location. Also the ID of a resource type is provided in the `type` field making the resource available for bookings. ```curl curl -X POST \ 'https://www.wixapis.com/bookings/v2/resources' \ -H 'Authorization: ' \ -d '{ "resource": { "name": "Meeting room with conference system", "typeId": "dd7790c7-f3ac-4821-accb-52ed385fd932", "location_options": { "specific_location_options": { "business_locations": [ { "location_id": "1295e5ff-ecb3-41bc-8b6f-7345792e5ec0" } ], "available_in_business_locations": true } } } }' ``` ### Create a resource. This is a minimal example of creating a resource. By default this resource is available in all locations. Only when the `type` field is provided can the resource be used for bookings. ```curl curl -X POST \ 'https://www.wixapis.com/bookings/v2/resources' \ -H 'Authorization: ' \ -d '{ "resource": { "name": "Some name" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.resources.ResourcesService.createResource(resource) Description: Creates a new resource. ### Connected schedules A new event [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/wix-bookings-integration.md) is automatically created for the resource. ### Locations If you don't specify `locationOptions`, Wix Bookings automatically sets `locationOptions.availableInAllLocations` to `true`. If you specify 1 business location GUID in `locationOptions.specificLocationOptions.businessLocations`, you must specify `locationOptions.specificLocationOptions.availableInBusinessLocations` as `true`. Currently, you can specify only a single business location. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: resource, resource.name Method parameters: param name: resource | type: Resource | description: A resource represents an entity, such as a room or a staff member, that can be scheduled for use in a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/about-the-bookings-apis.md). The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings. | required: true - name: name | type: string | description: Name of the resource. | required: true - name: typeId | type: string | description: GUID of the [resource type](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md). Once a type has been set it can't be modified. You can create a resource without specifying a type. However, customers can't book such resources. - name: workingHoursSchedules | type: WorkingHoursSchedules | description: Information about the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) specifying the working hours and locations of the resource. Resources without a working hour schedule are available 24/7 at the locations specified in the field `locationOptions`. When both `workingHoursSchedules` and `locationOptions` are set, `workingHoursSchedules` takes precedence. - name: values | type: array | description: Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. - name: scheduleId | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: locationOptions | type: LocationOptions | description: Information about the location where the resource is available. - name: availableInAllLocations | type: boolean | description: Whether the resource is available in all [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in all business locations. - `false`: The resource is available only in specific locations. Default: `false` - name: specificLocationOptions | type: SpecificLocation | description: Details of resource availability in specific locations. - name: availableInBusinessLocations | type: boolean | description: Whether the resource is available in [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in business locations. - `false`: The resource isn't available in business locations. Default: `false` - name: businessLocations | type: array | description: Information about the business locations where the resource is available. Not returned, if the resource is available in either all business locations or in no business location. You can specify up to 100 business locations. - name: locationId | type: string | description: GUID of the business [location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the resource. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: PROMISE - name: _id | type: string | description: Resource GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the resource is updated. To prevent conflicting changes, the current revision must be passed when updating the resource. - name: _createdDate | type: Date | description: Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was created. - name: _updatedDate | type: Date | description: Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was last updated. - name: name | type: string | description: Name of the resource. - name: typeId | type: string | description: GUID of the [resource type](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md). Once a type has been set it can't be modified. You can create a resource without specifying a type. However, customers can't book such resources. - name: workingHoursSchedules | type: WorkingHoursSchedules | description: Information about the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) specifying the working hours and locations of the resource. Resources without a working hour schedule are available 24/7 at the locations specified in the field `locationOptions`. When both `workingHoursSchedules` and `locationOptions` are set, `workingHoursSchedules` takes precedence. - name: values | type: array | description: Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. - name: scheduleId | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: shared | type: boolean | description: Whether the schedule is shared by multiple resources or unique for this resource. Default: `false` - name: locationOptions | type: LocationOptions | description: Information about the location where the resource is available. - name: availableInAllLocations | type: boolean | description: Whether the resource is available in all [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in all business locations. - `false`: The resource is available only in specific locations. Default: `false` - name: specificLocationOptions | type: SpecificLocation | description: Details of resource availability in specific locations. - name: availableInBusinessLocations | type: boolean | description: Whether the resource is available in [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations.md#location-types). - `true`: The resource is available in business locations. - `false`: The resource isn't available in business locations. Default: `false` - name: businessLocations | type: array | description: Information about the business locations where the resource is available. Not returned, if the resource is available in either all business locations or in no business location. You can specify up to 100 business locations. - name: locationId | type: string | description: GUID of the business [location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: eventsSchedule | type: EventsSchedule | description: Schedule containing the [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) for which the resource has been booked. - name: scheduleId | type: string | description: GUID of the event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md). - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the resource. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_AVAILABLE_IN_BUSINESS_LOCATION_MUST_BE_TRUE | Description: `availableInBusinessLocations` must be set to `true`. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_SPECIFIC_LOCATION_OPTIONS_MUST_BE_SET | Description: `specificLocationOptions` must be set when `availableInAllLocations` is set to `false` or empty. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_SPECIFIC_LOCATION_OPTIONS_NOT_ALLOWED | Description: `specificLocationOptions` can't be set when `availableInAllLocations` is set to `true`. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: RESOURCE_LOCATION_ID_IS_REQUIRED | Description: Business location GUID is required. ``` ### Examples ### createResource ```javascript import { resources } from '@wix/bookings'; async function createResource(resource) { const response = await resources.createResource(resource); }; ``` ### createResource (with elevated permissions) ```javascript import { resources } from '@wix/bookings'; import { auth } from '@wix/essentials'; async function myCreateResourceMethod(resource) { const elevatedCreateResource = auth.elevate(resources.createResource); const response = await elevatedCreateResource(resource); } ``` ### createResource (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { resources } from '@wix/bookings'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { resources }, // Include the auth strategy and host as relevant }); async function createResource(resource) { const response = await myWixClient.resources.createResource(resource); }; ``` ---