Generate/regenerate strategic score for a lead

POST /api/v1/leads/{leadId}/strategic-score

Error

A valid request URL is required to generate request examples

200

{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "score": {
      "id": "<string>",
      "dbId": 123,
      "leadId": "<string>",
      "totalScore": 123,
      "structuredOutput": {
        "scoringResults": [
          {
            "testName": "<string>",
            "friendlyName": "<string>",
            "score": 123,
            "maxScore": 123,
            "explanation": "<string>"
          }
        ],
        "appliedModifiers": [
          {
            "name": "<string>",
            "type": "boost",
            "value": 123,
            "reason": "<string>"
          }
        ],
        "overallReasoning": "<string>",
        "rawTotal": 123,
        "finalTotal": 123
      },
      "scoringSchema": {
        "fields": [
          {
            "name": "<string>",
            "displayName": "<string>",
            "maxScore": 123
          }
        ],
        "totalScore": 123
      },
      "promptVersion": 123,
      "modelUsed": "<string>",
      "isOutdated": true,
      "generatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  }
}

Path Parameters

leadId · string · required

Minimum string length: 1

Body

application/json

leadData · object · required

Show child attributes

forceRegenerate · boolean | null · required

Response

200

application/json

OK

ok · any · required

meta · object · required

Show child attributes

data · object · required

Show child attributes