Skip to main content
PUT
Update CrmBoardColumn
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 that owns this stage and determines its location access..
string
required
Required unique name for this CRM stage within its workflow, such as Contract Signature or Office Tour..
integer
required
Requested relative position in the board’s stage sequence; the server normalizes saved positions to 1, 100, 200, and so on..

Optional Fields

boolean
Whether customers who submit a tour request are automatically added to this stage while its board is active..
boolean
Whether customers who confirm a tour are automatically added to this stage while its board is active..
boolean
Whether customers who complete a tour are automatically added to this stage while its board is active..
boolean
Whether moving an existing opportunity to this stage marks it won; when both WinOpportunity and LoseOpportunity are true, winning is applied last..
boolean
Whether moving an existing opportunity to this stage marks it lost; WinOpportunity overrides this final status when both are true..
boolean
Whether customers who complete sign-up are automatically added to this stage while its board is active..
boolean
Whether customers who make a booking are automatically added to this stage while its board is active..
boolean
Whether customers who cancel are automatically added to this stage while its board is active..
boolean
Whether customers who are sent a proposal are automatically added to this stage while its board is active..
boolean
Whether customers who accept a proposal are automatically added to this stage while its board is active..
boolean
Whether customers who electronically sign a document are automatically added to this stage while its board is active..
boolean
Whether customers who register for an event are automatically added to this stage while its board is active..
boolean
Whether customers who send a contact message are automatically added to this stage while its board is active..
integer
Optional ID of the message macro sent to the customer when an opportunity enters this stage..
integer
Optional ID of the task list whose tasks are created for the customer when an opportunity enters this stage..
boolean
Whether task-list tasks use the task list’s configured assignees instead of the opportunity’s responsible user; applies only when TaskList is set..
integer
Read-only mirror of the enabled CRM stage workflow trigger that runs when an opportunity enters this stage. Set it by choosing this board and stage on the workflow trigger and enabling it, not by writing this field; disabling or repointing that trigger clears it..
boolean
Whether arrival at this stage activates the customer’s account and creates a user account when one is missing; DeactivateAccount runs afterward when also enabled..
boolean
Whether arrival at this stage schedules permanent deletion of the customer’s account and details shortly after the opportunity is moved..
boolean
Whether arrival at this stage deactivates the customer’s account; it runs after ActivateAccount when both are enabled..
boolean
Whether arrival at this stage confirms every unconfirmed tour at this location matching the customer’s email address..
boolean
Whether customers who purchase a selected product are automatically added to this stage; it is cleared when Products is empty or disabled..
integer[]
List of product IDs that trigger auto-assignment when ProductPurchased is enabled; the list must be non-empty and no product can trigger another stage in the same board..
integer[]
IDs added to the Products relationship..
integer[]
IDs removed from the Products relationship..
boolean
Whether customers who book a selected resource are automatically added to this stage; it is cleared when Resources is empty or disabled..
integer[]
List of resource IDs that trigger auto-assignment when ResourceBooked is enabled; the list must be non-empty and no resource can trigger another stage in the same board..
integer[]
IDs added to the Resources relationship..
integer[]
IDs removed from the Resources relationship..
boolean
Whether customers who check in to an event are automatically added to this stage while its board is active..

Code Examples

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

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.
boolean
false when the request fails validation.
Example Response