Skip to main content
POST
/
api
/
crm
/
customfields
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​
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.

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Name.
​
DisplayOrder
integer
required
Display Order.
​
CustomFieldIndex
integer
required
Custom Field Index.

​
Optional Fields

​
RecordType
integer
Record Type. See eCustomFieldRecordType enum above.
​
FieldType
integer
Field Type. See eFieldType enum above.
​
CoworkerFieldPosition
integer
Coworker Field Position. See eCoworkerFieldPosition enum above.
​
AvailableOptions
string
Available Options.
​
AllowMultipleOptions
boolean
Allow Multiple Options.
​
Required
boolean
Required.
​
GroupName
string
Group Name.
​
DisplayInPublicProfile
boolean
Display In Public Profile.
​
DisplayInDirectorySearch
boolean
Display In Directory Search.
​
NameInSearch
string
Name In Search.
​
Visibility
integer
Visibility. See eFieldVisibility enum above.
​
DisplayInSignUpForm
boolean
Display In Sign Up Form.
​
DisplayInProfileForm
boolean
Display In Profile Form.
​
DisplayInTourForm
boolean
Display In Tour Form.
​
DisplayInEventSignUpForm
boolean
Display In Event Sign Up Form.
​
ShowInBookingForm
boolean
Show In Booking Form.
​
DisplayInProductSignUpForm
boolean
Display In Product Sign Up Form.
​
DisplayInTeamSignUpForm
boolean
Display In Team Sign Up Form.
​
DisplayInCourseSignUpForm
boolean
Display In Course Sign Up Form.
​
DisplayInTariffSignUpForm
boolean
Display In Tariff Sign Up Form.
​
DisplayInBookingSignUpForm
boolean
Display In Booking Sign Up Form.
​
DisplayInResourceSearch
boolean
Display In Resource Search.
​
Resources
integer[]
Resources.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/crm/customfields" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "DisplayOrder": 0,
    "CustomFieldIndex": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the customfield was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CustomField was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}