Log a Decision
If you want to log decision data from your DMS into Approve Owl. This is useful for adding another marker in the sales funnel report and for adjusting the down payment value in the applicant profile.
Request
Requires Authorization
POST: https://sandbox.approveowl.com/api/v1/logged_decisions/
Required parameters:
An applicant is required for logging a decision. You can send the applicant id or the applicant phone number. If you send the phone number, Approve Owl will look up the applicant by phone number and use the first applicant found.
| Parameter | Type | Description |
|---|---|---|
| applicant_id | string | The UUID of the applicant in Approve Owl |
| phone_number | string | The phone number for the applicant in Approve Owl |
Other required parameters:
| Parameter | Type | Description |
|---|---|---|
| decision_id | string | The id of the decision used in your DMS |
| decision_at | string | The date/time of the decision in ISO 8601 format (2023-11-15T09:14:40-06:00) |
| decision_status | string | The status of the decision. Consider using categories like "Approved", "Denied", "Countered", etc |
Optional Parameters:
| Parameter | Type | Description |
|---|---|---|
| customer_id | string | The ID that your DMS uses to track customers. Consider supplying this if customers can have many decisions. |
| down_payment_amount | decimal | Approve Owl can update the available cash down in the applicant's profile when this value is supplied |
| retail_amount | decimal | The retail amount of the vehicle in the decision |
| term_length_in_months | integer | The term length of the loan in months in the decision |
| sales_rep_username | string | If you want to attribute the sale to a user in Approve Owl. It should be the email address of the user. |
| underwriter_username | string | If you want to attribute the decision to a user in Approve Owl. It should be the email address of the user. |
Example Request Body
{
"phone_number": "817-422-1829",
"decision_id": "123",
"decision_status": "CounterOffer",
"decision_at": "2023-11-15T17:09:39"
}Note, the decision_id should be sent as a string even if it is a number in your DMS.
Example Response
You will receive back Approve Owl's internal representation of the sale.
{
"organization_id": "b992584a-93eb-4052-9fd4-6e2dc770b097",
"phone_number": "817-422-1829",
"decision_id": "123",
"decision_status": "CounterOffer",
"decision_at": "2023-11-15T17:09:39.000-06:00",
"applicant_id": "949bb437-9f72-47c0-84cf-01e71defa481",
"id": "8616d085-00d9-4127-b4ce-8f4b6f60289d",
"customer_id": null,
"down_payment_amount": null,
"retail_amount": null,
"term_length_in_months": null,
"sales_rep_username": null,
"underwriter_username": null,
"created_at": "2023-11-15T09:14:40.558-06:00",
"updated_at": "2023-11-15T09:14:40.558-06:00"
}Errors
If your request is invalid, you will receive a 422 response with a JSON body containing the errors.
{
"errors": {
"applicant": ["must exist", "can't be blank"]
}
}