---
title: "create one or multiple customAttributes"
method: POST
path: "/api/serviceworkforce/customAttributes"
tags: ["customAttributes"]
---

# create one or multiple customAttributes

`POST /api/serviceworkforce/customAttributes`

Create one or multiple customAttributes

## Request body

- union
  - CustomAttribute
    - `uuid` string, uuid
    - `createdAt` string, date-time — Creation timestamp
    - `createdBy` string, uuid — Creator UUID
    - `lastUpdatedAt` string, date-time — Last update timestamp
    - `lastUpdatedBy` string, uuid — Last updater UUID
    - `lastUpdatedByAudience` string — Audience of last updater
    - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater
    - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID
    - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater
    - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater
    - `companyUuid` string, uuid — Company UUID
    - `label` string, required
    - `key` string
    - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
    - `description` string
    - `options` object[]
      - `value` string, required
      - `label` string
      - `hireValue` unknown
    - `resource` string
    - `resourceIdentifier` string, uuid
    - `readOnly` boolean — If true, this attribute cannot be modified. Can only be set by system.
    - `hidden` boolean — If true, this attribute won't be shown. Can only be set by system.
    - `protected` boolean — If true, this attribute can only be accessed by users with certain rights.
    - `hireDataKeyId` integer — The ID of the hire data key
  - CustomAttribute[]
    - `uuid` string, uuid
    - `createdAt` string, date-time — Creation timestamp
    - `createdBy` string, uuid — Creator UUID
    - `lastUpdatedAt` string, date-time — Last update timestamp
    - `lastUpdatedBy` string, uuid — Last updater UUID
    - `lastUpdatedByAudience` string — Audience of last updater
    - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater
    - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID
    - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater
    - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater
    - `companyUuid` string, uuid — Company UUID
    - `label` string, required
    - `key` string
    - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
    - `description` string
    - `options` object[]
      - `value` string, required
      - `label` string
      - `hireValue` unknown
    - `resource` string
    - `resourceIdentifier` string, uuid
    - `readOnly` boolean — If true, this attribute cannot be modified. Can only be set by system.
    - `hidden` boolean — If true, this attribute won't be shown. Can only be set by system.
    - `protected` boolean — If true, this attribute can only be accessed by users with certain rights.
    - `hireDataKeyId` integer — The ID of the hire data key

## Response `201`

One or many customAttribute documents created. Wrapped in a JsonAPI root response.

- object
  - `data` union
    - CustomAttribute
      - `uuid` string, uuid
      - `createdAt` string, date-time — Creation timestamp
      - `createdBy` string, uuid — Creator UUID
      - `lastUpdatedAt` string, date-time — Last update timestamp
      - `lastUpdatedBy` string, uuid — Last updater UUID
      - `lastUpdatedByAudience` string — Audience of last updater
      - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater
      - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID
      - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater
      - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater
      - `companyUuid` string, uuid — Company UUID
      - `label` string, required
      - `key` string
      - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
      - `description` string
      - `options` object[]
        - `value` string, required
        - `label` string
        - `hireValue` unknown
      - `resource` string
      - `resourceIdentifier` string, uuid
      - `readOnly` boolean — If true, this attribute cannot be modified. Can only be set by system.
      - `hidden` boolean — If true, this attribute won't be shown. Can only be set by system.
      - `protected` boolean — If true, this attribute can only be accessed by users with certain rights.
      - `hireDataKeyId` integer — The ID of the hire data key
    - CustomAttribute[]
      - `uuid` string, uuid
      - `createdAt` string, date-time — Creation timestamp
      - `createdBy` string, uuid — Creator UUID
      - `lastUpdatedAt` string, date-time — Last update timestamp
      - `lastUpdatedBy` string, uuid — Last updater UUID
      - `lastUpdatedByAudience` string — Audience of last updater
      - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater
      - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID
      - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater
      - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater
      - `companyUuid` string, uuid — Company UUID
      - `label` string, required
      - `key` string
      - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
      - `description` string
      - `options` object[]
        - `value` string, required
        - `label` string
        - `hireValue` unknown
      - `resource` string
      - `resourceIdentifier` string, uuid
      - `readOnly` boolean — If true, this attribute cannot be modified. Can only be set by system.
      - `hidden` boolean — If true, this attribute won't be shown. Can only be set by system.
      - `protected` boolean — If true, this attribute can only be accessed by users with certain rights.
      - `hireDataKeyId` integer — The ID of the hire data key
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/versions/5f406c0e9462/schema)