Update matching custom properties

PATCH

custom-property

bulk

curl --request PATCH \
  --url https://{instance}/api/v2/custom-property/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "identifier": "<string>",
  "isArchived": true,
  "key": "<string>",
  "name": "<string>",
  "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliverableTypes": [
    "order"
  ],
  "options": [
    "<string>"
  ],
  "allowsAdHocOptions": true
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifier: '<string>',
    isArchived: true,
    key: '<string>',
    name: '<string>',
    unitMeasureId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    deliverableTypes: ['order'],
    options: ['<string>'],
    allowsAdHocOptions: true
  })
};

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

import requests

url = "https://{instance}/api/v2/custom-property/bulk"

payload = {
    "identifier": "<string>",
    "isArchived": True,
    "key": "<string>",
    "name": "<string>",
    "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableTypes": ["order"],
    "options": ["<string>"],
    "allowsAdHocOptions": True
}
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",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isArchived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "identifier": "<string>",
      "key": "<string>",
      "name": "<string>",
      "dataType": "number",
      "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deliverableTypes": [
        "order"
      ],
      "options": [
        "<string>"
      ],
      "allowsAdHocOptions": true
    }
  ]
}

{
  "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

identifier

string

isArchived

boolean

key

string

Immutable storage key, unique case-insensitively even across archived definitions.

Required string length: 1 - 64

Pattern: ^[A-Za-z][A-Za-z0-9]*$

name

string

Minimum string length: 1

dataType

enum<string>

Available options:

number,

text,

boolean,

single_select,

multi_select

unitMeasureId

string<uuid> | null

Only number properties can have a unit.

deliverableTypes

enum<string>[]

Currently only ["order"] is supported; cannot be empty.

Available options:

order

options

string[]

Select types only. Trimmed strings, unique case-insensitively; array position is display order.

Minimum string length: 1

allowsAdHocOptions

boolean

Select types only. Append unknown options on value writes when true.

Response

Successful response.

values

object[]

Show child attributes

Update matching custom properties

curl --request PATCH \
  --url https://{instance}/api/v2/custom-property/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "identifier": "<string>",
  "isArchived": true,
  "key": "<string>",
  "name": "<string>",
  "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliverableTypes": [
    "order"
  ],
  "options": [
    "<string>"
  ],
  "allowsAdHocOptions": true
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifier: '<string>',
    isArchived: true,
    key: '<string>',
    name: '<string>',
    unitMeasureId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    deliverableTypes: ['order'],
    options: ['<string>'],
    allowsAdHocOptions: true
  })
};

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

import requests

url = "https://{instance}/api/v2/custom-property/bulk"

payload = {
    "identifier": "<string>",
    "isArchived": True,
    "key": "<string>",
    "name": "<string>",
    "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableTypes": ["order"],
    "options": ["<string>"],
    "allowsAdHocOptions": True
}
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",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isArchived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "identifier": "<string>",
      "key": "<string>",
      "name": "<string>",
      "dataType": "number",
      "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deliverableTypes": [
        "order"
      ],
      "options": [
        "<string>"
      ],
      "allowsAdHocOptions": true
    }
  ]
}

{
  "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)

Update matching custom properties

Authorizations

Query Parameters

Body

Response