Add

[POST] .../v1/dealtype/add

Creates a CRM deal type. Use this method to create a reusable CRM deal type before assigning it to deals or target/report filters. The method validates the name, rejects duplicates among non-deleted deal types, stores optional description and active flag, writes an action log record, invalidates the CRM deal type cache and returns new_id. The request body is required; name must be provided and is limited to 200 characters, while description is optional and stored as NULL when blank. The caller must have CRM deal type add permission; missing body or name, duplicate name, name length violations, denied access, 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 Deal type description.
name String Required Deal type name. Maximum length is 200 characters.

Request Example

{
  "name": "Wholesale deal",
  "description": "Deals with wholesale customers",
  "active": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 2
  }
}