Update CustomField

PUT

api

crm

customfields

Update CustomField

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/customfields \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "DisplayOrder": 123,
  "RecordType": 123,
  "FieldType": 123,
  "CoworkerFieldPosition": 123,
  "Visibility": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/customfields"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "DisplayOrder": 123,
    "RecordType": 123,
    "FieldType": 123,
    "CoworkerFieldPosition": 123,
    "Visibility": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    DisplayOrder: 123,
    RecordType: 123,
    FieldType: 123,
    CoworkerFieldPosition: 123,
    Visibility: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/customfields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing CustomField record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

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

Value	Name
1	Text
2	LongText
3	Boolean
4	Dropdown
5	Date
6	Integer
7	Decimal

eCoworkerFieldPosition — CoworkerFieldPosition values

Value	Name
1	General
2	Contact
3	Profile
4	Billing
5	Access
6	Notes

eFieldVisibility — Visibility values

Value	Name
1	Visible
2	ReadOnly
3	Internal

Request Body

Required Fields

integer

required

The Id of the CustomField record to update.

integer

required

ID of the location that owns this custom field. Customer fields must belong to the top-level location; other record types are available across the location network..

string

required

Required label shown for this custom field. It must be unique across the location network unless it is the linked resource/booking counterpart..

integer

required

Numeric display order for this field among the location’s custom fields; lower values appear first and the server normalizes the ordering after changes..

integer

required

Record type this field collects data for: Coworker, Team, FloorPlanDesk, CrmOpportunity, Visitor, Proposal, CoworkerInternal, HelpDeskMessage, HelpDeskDepartment, Product, Booking, CoworkerInvoice, Business, CoworkerContract, Tariff, Resource, FloorPlan, InventoryAsset, or Events. A Coworker field cannot later be changed to another type..

integer

required

Input type and validation for captured values: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal. AvailableOptions is retained only for Dropdown..

integer

required

Customer-record tab where the field is placed: General, Contact, Profile, Billing, Access, or Notes. This applies when RecordType is Coworker..

integer

required

Audience and editability: Visible allows customer editing, ReadOnly shows the field without customer editing, and Internal excludes it from public-facing field lists. ReadOnly cannot be Required..

Optional Fields

string

Comma-separated permitted choices for a Dropdown field; submitted values must exactly match these trimmed options. The server clears this value for every other FieldType..

boolean

Whether a Dropdown field accepts more than one comma-separated choice. This setting is meaningful only when FieldType is Dropdown..

boolean

Whether a non-empty value is required when this field is submitted on its parent record. ReadOnly fields are automatically made not required..

string

Optional label used to group related custom fields in supported forms..

boolean

Whether this customer field is shown on the customer’s public profile..

boolean

Whether this customer field is offered as a filter in the public customer directory search..

string

Optional label shown for this field in customer-directory search; use it when the normal field label needs different search wording..

Whether this custom field is shown on the customer sign-up form..

boolean

Whether this custom field is shown on the customer profile-edit form..

boolean

Whether this custom field is shown on the tour request form..

Whether this custom field is shown when a customer registers for an event..

boolean

Whether this field is shown on a resource booking form. For Resource record types, enabling this creates or synchronizes a linked Booking custom field..

Whether this custom field is shown when a customer buys a product..

Whether this custom field is shown on the team sign-up form..

Whether this custom field is shown on the course sign-up form..

Whether this custom field is shown when a customer signs up for a plan (Tariff)..

Whether this custom field is shown on the booking sign-up form..

boolean

Whether this custom field is offered as a filter in resource search..

integer[]

List of resources this Resource-record custom field applies to when it is shown in booking. An empty list means it applies to every resource; setting resources restricts it to those resources..

integer[]

IDs added to the Resources relationship..

integer[]

IDs removed from the Resources relationship..

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/crm/customfields" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "DisplayOrder": 0,
    "RecordType": 0,
    "FieldType": 0,
    "CoworkerFieldPosition": 0,
    "Visibility": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/customfields',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      DisplayOrder: 0,
      RecordType: 0,
      FieldType: 0,
      CoworkerFieldPosition: 0,
      Visibility: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/crm/customfields',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'DisplayOrder': 0,
        'RecordType': 0,
        'FieldType': 0,
        'CoworkerFieldPosition': 0,
        'Visibility': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the customfield was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CustomField was successfully updated.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update CustomField

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/customfields \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "DisplayOrder": 123,
  "RecordType": 123,
  "FieldType": 123,
  "CoworkerFieldPosition": 123,
  "Visibility": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/customfields"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "DisplayOrder": 123,
    "RecordType": 123,
    "FieldType": 123,
    "CoworkerFieldPosition": 123,
    "Visibility": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    DisplayOrder: 123,
    RecordType: 123,
    FieldType: 123,
    CoworkerFieldPosition: 123,
    Visibility: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/customfields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400