API – Do Not Call
In the event that you wish to mark a particular phone number as "Do Not Call", you can do so through the API or by changing the status in the UI. If you wish to make the change in the UI, reference the article Customer Phone Number for instructions on how to do so. Here, we explain to make the change using the API.
Changing the status to "Do Not Call" will remove the phone number from any TCN phone calls. It can also be used to notify your employees not to contact the Customer via that method. Changing the status of a phone to "Do Not Call" via the API is a 2 step process. Step 1 is to GET the phone number entity for the customer you're working with, and step 2 is to update the status to "Do Not Call".
Use a GET API call to pull the needed phone information from LoanPro. You will send the request to the following endpoint:
This request's response will then provide all of the IDs for the phone numbers that are tied to the customer. The ID of the phone number that needs to be marked as "Do Not Call" will be used in step 2.
Next, send a PUT request to set the Do Not Call setting for the customer. Send the request to the following URL:
In this step, you again use the Customers endpoint. Then, in the payload, you will reference the ID of the phone number. In the example listed below, we use the phone number ID of 771.
Here's a breakdown of the parameters used in the body of this request:
The ID of the customer's phone number.
This determines whether the phone number should be listed as "Do Not Call".
This updates the phone number.
This is the ID of the phone number being updated.