This article will detail how to add deal notes or change deal status in Bulk or change a Deal Status via our MCA REST API v2.
Keep in mind, to change a deal status in the front end requires you to add a deal note. This will be the same process through the API.
There will be a maximum of 50 notes at once.
Authentication
All calls require two identifying header parameters for credentialing:
1. X_MCASUITE_APP_ID
2. X_MCASUITE_APP_TOKEN
Both of these values will be generated by MCA Suite and provided to our customers. Please contact your representative to get these credentials.
URLS:
The Base REST URL will be provided to the customer upon API request. The URL will be different than our version 1 API.
Format:
The API will only accept json encoded parameters.
Function:
Name: deal/addNotes
Type: POST
Parameters:
| Field Name | Required? | Type | Description |
| notes | Yes | Array | Array of dealId, status and note. [{dealId:123,status:'New',note:'This is a note'}] dealId is required status OR note is required |
JSON Example:
This example will add two notes to two different deals. One will change the status.
{
"notes":[
{
"dealId":8190,
"note":"Marshmellow"
},
{
"dealId":81390,
"status":"Awaiting Application",
"note":"HI"
}
]
}
Return JSON Examples
{
"success": true,
"notesAdded": 0,
"results": [
{
"index": "0",
"errors": [
"Note a valid deal id: 56382"
]
},
{
"index": "1",
"errors": [
"Note a valid deal id: 74786"
]
}
]
}