If you'd like to use your own scoring model to predict the likelihood of a lead or opportunity closing, use the msdyn_predictivescores entity to populate predictive scores for your leads and opportunities.
Add predictive score for a specific record
Use the POST request to add a predictive score for a specific record.
Sample request
POST /api/data/v9.0/msdyn_predictivescores HTTP/1.1
Content-Type: application/json
Host: contoso.crm.dynamics.com
Content-Length: 158
{
"msdyn_score": 90,
"msdyn_scoretrend": 0,
"msdyn_grade": 0,
"msdyn_entityid": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"msdyn_entitytype": "lead"
}
Update predictive score for a specific record
Use the PATCH request to update a predictive score for a specific record.
Sample request
PATCH /api/data/v9.0/msdyn_predictivescores(msdyn_entityid=%2700aa00aa-bb11-cc22-dd33-44ee44ee44ee%27,msdyn_entitytype=%27lead%27) HTTP/1.1
Content-Type: application/json
Host: contoso.crm.dynamics.com
Content-Length: 68
{
"msdyn_score": 95,
"msdyn_scoretrend": 0,
"msdyn_grade": 0
}
Parameters
The following parameters are used in the POST and PATCH requests:
Host: Specifies the URL of your Dynamics 365 Sales environment.
msdyn_score: Specifies the predictive score value.
msdyn_scoretrend: Specifies how the score is trending.
Allowed value Description 0 Improving 1 Steady 2 Declining 3 Not enough info msdyn_grade: Specifies the grade associated with the score.
Allowed Value Description 0 Grade A 1 Grade B 2 Grade C 3 Grade D msdyn_entityid: Specifies the unique identifier of the entity.
msdyn_entitytype: Specifies the type of entity - "lead" or "opportunity".
Response
The following response code is returned for both POST and PATCH requests:
Status: 204 No Content