Upsert a custom property

PUT

custom-property

{id}

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

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

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

import requests

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

payload = {
    "key": "<string>",
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identifier": "<string>",
    "isArchived": True,
    "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableTypes": ["order"],
    "options": ["<string>"],
    "allowsAdHocOptions": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "value": {
    "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": {}
}

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

Path Parameters

string<uuid>

required

Record id.

Query Parameters

update

string[]

required

Columns to overwrite when the row already exists. Repeat the parameter for each column: a single comma-separated value is read as one column name and fails at the database. Without the parameter the request is rejected with 400.

Body

application/json

key

string

required

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

required

Minimum string length: 1

dataType

enum<string>

required

Available options:

number,

text,

boolean,

single_select,

multi_select

string<uuid>

identifier

string

isArchived

boolean

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.

value

object

Show child attributes

Upsert a custom property

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

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

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

import requests

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

payload = {
    "key": "<string>",
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identifier": "<string>",
    "isArchived": True,
    "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableTypes": ["order"],
    "options": ["<string>"],
    "allowsAdHocOptions": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "value": {
    "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": {}
}

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

Path Parameters

Query Parameters

Body

Response