Qualification Management

Qualification Management provides functionality to manage qualification rules for opportunities within the system. This service enables creating, updating, and retrieving qualification rules associated with clients.

Qualification Operations

Qualification Operations provide tools to create, update, and retrieve qualification rules, enabling the evaluation of opportunities based on predefined criteria.

Qualification Operations - Create Qualification `POST` /v1/api/qualification/create

Resource URL	/v1/api/qualification/create
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required	Type	Default Value
rule_name	Name of the qualification rule	Yes	String	N/A
rule	Array of rule conditions for qualification	Yes	Array[RuleBase]	N/A
client_id	ID of the client associated with this qualification	Yes	String	N/A
create_user	User who created the qualification rule	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/qualification/create' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "rule_name": "High Value Opportunity",
    "rule": [
        {
            "field": "Quantum",
            "operator": ">",
            "value": 10000,
            "logical_operator": "and"
        },
        {
            "field": "Cost",
            "operator": "<",
            "value": 5000,
            "logical_operator": "and"
        }
    ],
    "client_id": "98765",
    "create_user": "john.doe"
}'

Example Response

{
  "is_error": false,
  "message": "Create Qualification Success",
  "results": {
    "rule_name": "string",
    "rule": [
      {
        "field": "Outcome",
        "operator": ">",
        "value": 0,
        "logical_operator": "and"
      }
    ],
    "client_id": "string",
    "create_user": "string",
    "id": "12343456",
    "created_at": "2025-04-07T07:07:01.865000",
    "updated_at": "2025-04-07T07:07:01.865000"
  }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Qualification Operations - Update Qualification `PUT` /v1/api/qualification/update/{qualification_id}

Resource URL	/v1/api/qualification/update/{qualification_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required	Type	Default Value
qualification_id	ID of the qualification to update	Yes	String	N/A
rule_name	Name of the qualification rule	Yes	String	N/A
rule	Array of rule conditions for qualification	Yes	Array[RuleBase]	N/A

Example Request

curl -X 'PUT' \
'https://braegen.ai/v1/api/qualification/update/54321' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "rule_name": "Updated High Value Opportunity",
    "rule": [
        {
            "field": "Quantum",
            "operator": ">",
            "value": 15000,
            "logical_operator": "and"
        },
        {
            "field": "Cost",
            "operator": "<",
            "value": 6000,
            "logical_operator": "and"
        }
    ]
}'

Example Response

{
    "is_error": false,
    "message": "Qualification updated successfully",
    "data": {
        "qualification_id": "54321",
        "rule_name": "Updated High Value Opportunity"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Qualification Operations - Get Qualification Rule `GET` /v1/api/qualification/get_qualification_rule/{client_id}

Resource URL	/v1/api/qualification/get_qualification_rule/{client_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
client_id	Path parameter: ID of the client

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/qualification/get_qualification_rule/98765' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Qualification rule retrieved successfully",
    "data": {
        "qualification_id": "54321",
        "rule_name": "High Value Opportunity",
        "rule": [
            {
                "field": "Quantum",
                "operator": ">",
                "value": 10000,
                "logical_operator": "and"
            },
            {
                "field": "Cost",
                "operator": "<",
                "value": 5000,
                "logical_operator": "and"
            }
        ],
        "client_id": "98765"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Qualification Management

Qualification Operations

Qualification Operations - Create Qualification POST /v1/api/qualification/create

HTTP Responses

Qualification Operations - Update Qualification PUT /v1/api/qualification/update/{qualification_id}

HTTP Responses

Qualification Operations - Get Qualification Rule GET /v1/api/qualification/get_qualification_rule/{client_id}

HTTP Responses

On this page

Qualification Operations - Create Qualification `POST` /v1/api/qualification/create

Qualification Operations - Update Qualification `PUT` /v1/api/qualification/update/{qualification_id}

Qualification Operations - Get Qualification Rule `GET` /v1/api/qualification/get_qualification_rule/{client_id}