Skip to main content
POST
Create a custom field
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json
label
string
required

Display label of the custom field. Not required to be unique.

Required string length: 1 - 120
fieldType
enum<string>
required

Type of data this field holds.

Available options:
SELECT,
MULTI_SELECT,
CHECKBOX,
TEXT,
DATE,
NUMBER,
URL
applyTo
enum<string>[]
required

Entity types this field applies to. One or more of DEVICE, ACCESSORY, EMPLOYEE, ORDER.

Minimum array length: 1
Available options:
DEVICE,
ACCESSORY,
EMPLOYEE,
ORDER
options
object[]

Option catalog. Only allowed (and required) for SELECT and MULTI_SELECT field types.

Response

201 - application/json
id
string
required
companyId
string
required
label
string
required
fieldType
enum<string>
required
Available options:
SELECT,
MULTI_SELECT,
CHECKBOX,
TEXT,
DATE,
NUMBER,
URL
applyTo
enum<string>[]
required
Available options:
DEVICE,
ACCESSORY,
EMPLOYEE,
ORDER
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED
options
object[]
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$