CustomFields
Create CustomField
Create a new CustomField record.
POST
Create CustomField
A CustomField defines an additional field available for a specific entity type. Nexudus supports attaching arbitrary data to any entity type via the CustomFields array.
Each custom field targets a single
RecordType (e.g. Coworker, Team, Booking, Product) and has a FieldType that determines how the value is captured and stored (Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal).
For Dropdown fields, populate AvailableOptions with a comma-separated list of choices. Set AllowMultipleOptions to true to let users select more than one.
The CustomFieldIndex uniquely identifies the field within its record type and business, and is used to map values in the entity’s CustomFields array.
Use the Visibility property to control whether the field is Visible, ReadOnly, or Internal (admin-only). The various DisplayIn* flags control where the field appears: sign-up forms, profile forms, tour forms, event sign-up, booking forms, directory search, and public profiles.
Custom fields targeting the Coworker record type can be placed in a specific tab using CoworkerFieldPosition (General, Contact, Profile, Billing, Access, or Notes).
When RecordType is FloorPlanDesk or Resource, link specific resources via the Resources many-to-many list.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CustomField-Create role.Enums
eCustomFieldRecordType — RecordType values
eCustomFieldRecordType — RecordType values
| Value | Name |
|---|---|
| 1 | Coworker |
| 2 | Team |
| 3 | FloorPlanDesk |
| 4 | CrmOpportunity |
| 5 | Visitor |
| 6 | Proposal |
| 7 | CoworkerInternal |
| 8 | HelpDeskMessage |
| 9 | HelpDeskDepartment |
| 10 | Product |
| 11 | Booking |
| 12 | CoworkerInvoice |
| 13 | Business |
| 14 | CoworkerContract |
| 15 | Tariff |
| 16 | Resource |
| 17 | FloorPlan |
| 18 | InventoryAsset |
eFieldType — FieldType values
eFieldType — FieldType values
| Value | Name |
|---|---|
| 1 | Text |
| 2 | LongText |
| 3 | Boolean |
| 4 | Dropdown |
| 5 | Date |
| 6 | Integer |
| 7 | Decimal |
eCoworkerFieldPosition — CoworkerFieldPosition values
eCoworkerFieldPosition — CoworkerFieldPosition values
| Value | Name |
|---|---|
| 1 | General |
| 2 | Contact |
| 3 | Profile |
| 4 | Billing |
| 5 | Access |
| 6 | Notes |
eFieldVisibility — Visibility values
eFieldVisibility — Visibility values
| Value | Name |
|---|---|
| 1 | Visible |
| 2 | ReadOnly |
| 3 | Internal |
Request Body
Required Fields
Business this custom field belongs to.
Field label displayed to users.
Sort order when multiple custom fields are shown together.
Entity type this field applies to: Coworker, Team, Booking, Product, Resource, etc..
Data type of the field: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal.
Tab where this field appears on the coworker record: General, Contact, Profile, Billing, Access, or Notes.
Unique index identifying this field within its record type and business.
Visibility level: Visible (editable by customer), ReadOnly (shown but not editable), or Internal (admin only).
Optional Fields
Comma-separated list of choices for Dropdown fields.
Whether multiple options can be selected for Dropdown fields.
Whether a value must be provided when saving the parent entity.
Optional group name used to visually group related custom fields together.
Show this field on the coworker’s public profile page.
Show this field as a filter in the member directory search.
Alternative label shown when this field appears in directory search filters.
Show this field on the member sign-up form.
Show this field on the member profile edit form.
Show this field on the tour booking form.
Show this field on the event sign-up form.
Show this field on the resource booking form.
Show this field on the product purchase form.
Show this field on the team sign-up form.
Show this field on the course sign-up form.
Show this field on the pricing plan (tariff) sign-up form.
Show this field on the booking sign-up form.
Show this field as a filter in resource search.
Resources this custom field is linked to (for FloorPlanDesk or Resource record types).
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the customfield was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Create CustomField