Update many users

PATCH

organization-member

bulk

Update many users

curl --request PATCH \
  --url https://{instance}/api/v2/organization-member/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roleType": "custom",
  "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    roleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    roleType: 'custom',
    workerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://{instance}/api/v2/organization-member/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/organization-member/bulk"

payload = {
    "name": "<string>",
    "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roleType": "custom",
    "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "appUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleType": "custom",
      "status": "active",
      "appUser": {
        "email": "jsmith@example.com",
        "name": "<string>",
        "status": "pending",
        "isApiKey": true
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

Authorizations

X-API-Key

string

header

required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

string

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter

string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json

Every field is optional. Only the fields you send are changed. email is not updatable: it identifies the login and is owned by the identity provider.

name

string

Display name. Written to the linked user account, so it comes back as appUser.name rather than on the membership.

Minimum string length: 1

roleId

string<uuid> | null

Role the user carries.

roleType

enum<string>

default:custom

admin grants everything. custom follows roleId.

Available options:

admin,

custom

workerId

string<uuid> | null

Person record to link this user to. Pass null to unlink. Write-only — it is stored on the person, not on the membership.

Response

The updated users.

values

object[]

required

Show child attributes

Update many users

curl --request PATCH \
  --url https://{instance}/api/v2/organization-member/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roleType": "custom",
  "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    roleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    roleType: 'custom',
    workerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://{instance}/api/v2/organization-member/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/organization-member/bulk"

payload = {
    "name": "<string>",
    "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roleType": "custom",
    "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "appUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleType": "custom",
      "status": "active",
      "appUser": {
        "email": "jsmith@example.com",
        "name": "<string>",
        "status": "pending",
        "isApiKey": true
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

Overview

Projects

Stages

Deliverables

Work sessions

Dependencies

Documents

Custom properties

QC

People (Workers)

Timesheets

Codes

Roles

Users

Domain concepts

Items

Item vendors

Inventory stock

Inventory transactions

Inventory allocations

BOM lines

Production outputs

Units of measure

Vendors

Locations

Deliveries

Delivery lines

Trucks

Contacts

Project contacts

Teams

Shifts

Departments (shops)

Authorizations

Query Parameters

Body

Response