Edit

[POST] .../v1/dealtype/edit

Edits a CRM deal type. Use this method to rename a CRM deal type, change its description or toggle whether it is active for future workflows. The method changes only fields present in the request, stores an empty description as NULL, rejects duplicate non-deleted names, writes an action log record when a row is affected, invalidates the CRM deal type cache and returns row_affected with changed ids. The request body is required; id must be positive, name is optional but cannot be blank when provided and name is limited to 200 characters. The caller must have CRM deal type edit permission; missing body, invalid id or name, duplicate name, denied access, missing deal type, database failures, transaction failures and action-log errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
active Boolean Optional Active flag.
description String Optional New description. An empty string is stored as NULL.
id Int64 Required Deal type ID.
name String Optional New deal type name. Maximum length is 200 characters.

Request Example

{
  "id": 2,
  "name": "Priority wholesale deal",
  "description": "Priority B2B deals",
  "active": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      2
    ]
  }
}