Update a custom attribute

patch

https://services.fountain.com/api/serviceworkforce/customAttributes/{identifier}

Update selected fields on one custom attribute. Fields omitted from the request remain unchanged.

A custom attribute defines a field on a worker profile, including how that field is configured. The worker's value for that field belongs to the worker record.

Path Params

identifier

uuid

required

customAttribute unique identifier

Body Params

uuid

companyUuid

uuid

Company UUID

label

string

required

key

string

dataType

string

enum

required

description

string

options

array of objects

options

resource

string

resourceIdentifier

uuid

readOnly

boolean

Defaults to false

If true, this attribute cannot be modified. Can only be set by system.

hidden

boolean

Defaults to false

If true, this attribute won't be shown. Can only be set by system.

protected

boolean

Defaults to false

If true, this attribute can only be accessed by users with certain rights.

hireDataKeyId

integer

The ID of the hire data key

origin

string

enum

Which system authored this attribute definition

Allowed:

attributeSectionUuid

uuid | null

UUID of the attributeSection this attribute is grouped under on the worker profile Attributes tab. Null, absent or a deleted section means unassigned: the UI renders an unassigned applicant-origin attribute (hireDataKeyId set) under the virtual "Applicant Attributes" section, otherwise under a trailing "Other" group. A hidden attribute never renders, even inside a company section.

validation

Optional format rule enforced on this attribute. Absent means no rule: exactly the pre-validation behavior. Send null to remove a rule — over JSON that is the only way to say "clear it", since an absent key is a partial patch that leaves the stored rule alone.

Responses

202updated customAttribute. Wrapped in a JsonAPI root response.

500default error response