Update CrmBoardColumn

PUT

api

crm

crmboardcolumns

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/crmboardcolumns \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CrmBoardId": 123,
  "Name": "<string>",
  "Position": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CrmBoardId": 123,
    "Name": "<string>",
    "Position": 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, CrmBoardId: 123, Name: '<string>', Position: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmboardcolumns', 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 CrmBoardColumn 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 CrmBoardColumn-Edit role.

Request Body

Required Fields

integer

required

The Id of the CrmBoardColumn record to update.

integer

required

ID of the crm board linked to this record.

string

required

Stage name (e.g. ‘Contract Signature’, ‘Keys Handout’, ‘Office Tour’).

integer

required

Display order of this stage within the board (0-based).

Optional Fields

boolean

Auto-assign: add anyone completing a tour request form to this stage.

boolean

Auto-assign: add anyone confirming a tour to this stage.

boolean

Auto-assign: add anyone completing a tour to this stage.

boolean

Auto-action: mark opportunity as won when added to this stage.

boolean

Auto-action: mark opportunity as lost when added to this stage.

boolean

Auto-assign: add anyone completing a sign-up form to this stage.

boolean

Auto-assign: add anyone placing a booking to this stage.

boolean

Auto-assign: add anyone cancelling their contract to this stage.

boolean

Auto-assign: add anyone sent a proposal to this stage.

boolean

Auto-assign: add anyone accepting a proposal to this stage.

boolean

Auto-assign: add anyone e-signing a document to this stage.

boolean

Auto-assign: add anyone registering for an event to this stage.

boolean

Auto-assign: add anyone sending a contact message to this stage.

integer

Auto-action: message macro to send when an opportunity reaches this stage.

integer

Auto-action: task list to create when an opportunity reaches this stage.

boolean

Assign the task list’s own responsible users instead of the opportunity owner.

boolean

Auto-action: activate the account of opportunities added to this stage.

boolean

Auto-action: permanently delete the account and all customer details of opportunities added to this stage.

boolean

Auto-action: deactivate the account of opportunities added to this stage.

boolean

Auto-action: confirm the tour of opportunities added to this stage.

boolean

Auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.

integer[]

Product IDs that trigger auto-assignment when ProductPurchased is enabled.

integer[]

The added products value for this crm board column.

integer[]

The removed products value for this crm board column.

boolean

Auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.

integer[]

Resource IDs that trigger auto-assignment when ResourceBooked is enabled.

integer[]

The added resources value for this crm board column.

integer[]

The removed resources value for this crm board column.

boolean

Auto-assign: add any event attendee who checks in for an event to this stage.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/crm/crmboardcolumns" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CrmBoardId": 0,
    "Name": "",
    "Position": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmboardcolumns',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CrmBoardId: 0,
      Name: '',
      Position: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CrmBoardId': 0,
        'Name': '',
        'Position': 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 crmboardcolumn was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CrmBoardColumn 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
}

Delete CrmBoardColumnDelete an existing CrmBoardColumn record by its Id.

Update CrmBoardColumn

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/crmboardcolumns \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CrmBoardId": 123,
  "Name": "<string>",
  "Position": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CrmBoardId": 123,
    "Name": "<string>",
    "Position": 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, CrmBoardId: 123, Name: '<string>', Position: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmboardcolumns', 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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400