cURL
curl --request POST \
--url https://api.finosu.com/scheduled-calls/{customerId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"scheduleType": "<string>"
}
'import requests
url = "https://api.finosu.com/scheduled-calls/{customerId}"
payload = { "scheduleType": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({scheduleType: '<string>'})
};
fetch('https://api.finosu.com/scheduled-calls/{customerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/scheduled-calls/{customerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheduleType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/scheduled-calls/{customerId}"
payload := strings.NewReader("{\n \"scheduleType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.finosu.com/scheduled-calls/{customerId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduleType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/scheduled-calls/{customerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduleType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"customerId": "<string>",
"scheduledTime": "<string>",
"status": "<string>",
"callId": "<string>",
"postProcessingFlags": null
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Scheduled Calls
Create Scheduled Calls
Creates scheduled calls for a customer. For origination enrollment use POST /customers/schedule/sync; for configured loan-based collections boarding use POST /loans.
POST
/
scheduled-calls
/
{customerId}
cURL
curl --request POST \
--url https://api.finosu.com/scheduled-calls/{customerId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"scheduleType": "<string>"
}
'import requests
url = "https://api.finosu.com/scheduled-calls/{customerId}"
payload = { "scheduleType": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({scheduleType: '<string>'})
};
fetch('https://api.finosu.com/scheduled-calls/{customerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/scheduled-calls/{customerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheduleType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/scheduled-calls/{customerId}"
payload := strings.NewReader("{\n \"scheduleType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.finosu.com/scheduled-calls/{customerId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduleType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/scheduled-calls/{customerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduleType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"customerId": "<string>",
"scheduledTime": "<string>",
"status": "<string>",
"callId": "<string>",
"postProcessingFlags": null
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Existing integrations using this operation must provide their configured
scheduleType identifier. Unsupported identifiers are rejected; the values from
GET /origination/task-types are not identifiers for this operation.
For new-application or returning-borrower outreach, use
Origination Enrollment.
For accounts configured for loan-based collections boarding, create the customer
and then use Create Loan.
Customer lookup
customerId is the customer reference ID you supplied when creating the
customer, not a Finosu UUID. An unknown reference ID for your company returns
404.
Response
Returns201 with the array of scheduled calls created. customerId echoes
your customer reference ID, scheduledTime is an ISO 8601 timestamp with UTC
offset, and each call starts in status PENDING. callId is null until a
call is placed for the entry.
Errors
InvalidscheduleType values or a missing/invalid customer timezone or missing/blank state return 422.
Unexpected failures while creating the schedule return 500.Body
application/json
Required scheduling configuration for existing integrations.
Response
Array of scheduled calls created