Create a project user role

POST

https://acme-api.invivo.benchling.com/api/public/v1/projects/:projectId/roles

POST

/api/public/v1/projects/:projectId/roles

curl -X POST https://acme-api.invivo.benchling.com/api/public/v1/projects/pjt_9kLmNpQrStUvWxYzAbCdEf/roles \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "project_role_id": "prl_1tHOGjQEVLbLwIySNtIg8s",
  "user_id": "usr_2fBnKqWxYz5tRvMpLsJdHc"
}'

{
  "id": "psl_2Km5M6HoEtWBWt0bUoLwUB",
  "role": {
    "id": "prl_1tHOGjQEVLbLwIySNtIg8s",
    "name": "string"
  },
  "user": {
    "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
    "name": "string",
    "email": "string"
  },
  "project": {
    "id": "pjt_9kLmNpQrStUvWxYzAbCdEf",
    "name": "string",
    "metadata": {
      "cohort_size": 24,
      "species": "Mus musculus"
    },
    "created_at": "2026-09-18T14:03:22.123456Z",
    "updated_at": "2026-09-18T14:03:22.123456Z"
  },
  "created_at": "2026-09-18T14:03:22.123456Z",
  "updated_at": "2026-09-18T14:03:22.123456Z"
}

Assigns a user to a project role on the project.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

projectIdstringRequiredformat: "^pjt_[a-zA-Z0-9]{10,22}$"

The unique identifier of the project.

Request

The project role and user to assign.

project_role_idstringRequiredformat: "^prl_[a-zA-Z0-9]{10,22}$"

The unique identifier of the project role.

user_idstringRequiredformat: "^usr_[a-zA-Z0-9]{10,22}$"

The unique identifier of the user.

Response headers

X-RateLimit-LimitintegerOptional

The number of requests permitted in the current rate limit window.

X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional

The number of seconds until the current rate limit window resets.

Response

The project user role was created.

idstringformat: "^psl_[a-zA-Z0-9]{10,22}$"

Unique identifier for a project user role.

roleobject

The project role associated to a project user role.

userobject

The user associated to a project user role.

projectobject

A project that groups related studies.

created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error