---
title: "Creating a new Workspace Resource"
method: POST
path: "/workspace_resources"
tags: ["Workspace Resources"]
---

# Creating a new Workspace Resource

`POST /workspace_resources`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/workspace_resources`
- Auth: none declared

Adds a named or unnamed resource to a project (workspace).

**Bulk Create**

This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

```
{
  "workspace_resources": [
    {
      "workspace_id": 123,
      "user_id": 111,
      "role_id": 555
    },
    {
      "workspace_id": 123,
      "user_id": 222,
      "role_id": 666
    }
  ]
}
```


This endpoint returns structured Workspace Resource objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `workspace_resources` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `include` string
- `optional_fields` string[]

## Request body

- object
  - `workspace_resource` object
    - `workspace_id` integer, required: The workspace ID associated with this resource.
    - `user_id` integer: The user ID associated with this resource. A null value indicates that this is an unnamed resource.
    - `role_id` integer: The role ID associated with this resource. The role ID is a required attribute to create unnamed resources. This defaults to the user's primary project role if the user is specified.
    - `external_reference` object: Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).
      - `service_name` string, required: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
      - `service_model` string, required: The object type of the external object this external reference belongs to.
      - `service_model_ref` string, required: The object ID of the external object this external reference belongs to.
      - `status` string: The status of the integration. Options are `successful`, `pending`, or `failed`.
      - `external_message` string: The message on the external object.
      - `external_link` string: The link to the external object.
      - `external_status` string: The status of the external object in the external system.
      - `locked` boolean: Whether the subject is locked.

## Response `200`

Workspace Resource has been created.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `workspace_resources` object
  - `external_references` object
  - `users` object
  - `roles` object
  - `organization_memberships` object
  - `participations` object
  - `workspaces` object
  - `custom_field_values` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)