Import Waitlist
curl --request POST \
--url https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist \
--header 'Content-Type: application/json' \
--data '
{
"entries": [
{
"id": "<string>",
"patient_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_date_of_birth": "<string>",
"patient_phone": "<string>",
"added_to_waitlist_at": "<string>",
"note": "<string>",
"source": "waitlist",
"appointment_id": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"appointment_type_id": "<string>",
"appointment_type_name": "<string>",
"appointment_start": "<string>",
"appointment_end": "<string>",
"appointment_duration_minutes": 123
}
],
"launch": false,
"allow_duplicates": false,
"suggested_time_slot": {
"start": "<string>",
"end": "<string>",
"notes": "<string>"
},
"timezone": "America/New_York",
"ehr_source": "modmed"
}
'import requests
url = "https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist"
payload = {
"entries": [
{
"id": "<string>",
"patient_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_date_of_birth": "<string>",
"patient_phone": "<string>",
"added_to_waitlist_at": "<string>",
"note": "<string>",
"source": "waitlist",
"appointment_id": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"appointment_type_id": "<string>",
"appointment_type_name": "<string>",
"appointment_start": "<string>",
"appointment_end": "<string>",
"appointment_duration_minutes": 123
}
],
"launch": False,
"allow_duplicates": False,
"suggested_time_slot": {
"start": "<string>",
"end": "<string>",
"notes": "<string>"
},
"timezone": "America/New_York",
"ehr_source": "modmed"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
entries: [
{
id: '<string>',
patient_id: '<string>',
patient_first_name: '<string>',
patient_last_name: '<string>',
patient_date_of_birth: '<string>',
patient_phone: '<string>',
added_to_waitlist_at: '<string>',
note: '<string>',
source: 'waitlist',
appointment_id: '<string>',
provider_id: '<string>',
provider_name: '<string>',
location_id: '<string>',
location_name: '<string>',
appointment_type_id: '<string>',
appointment_type_name: '<string>',
appointment_start: '<string>',
appointment_end: '<string>',
appointment_duration_minutes: 123
}
],
launch: false,
allow_duplicates: false,
suggested_time_slot: {start: '<string>', end: '<string>', notes: '<string>'},
timezone: 'America/New_York',
ehr_source: 'modmed'
})
};
fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist', 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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist",
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([
'entries' => [
[
'id' => '<string>',
'patient_id' => '<string>',
'patient_first_name' => '<string>',
'patient_last_name' => '<string>',
'patient_date_of_birth' => '<string>',
'patient_phone' => '<string>',
'added_to_waitlist_at' => '<string>',
'note' => '<string>',
'source' => 'waitlist',
'appointment_id' => '<string>',
'provider_id' => '<string>',
'provider_name' => '<string>',
'location_id' => '<string>',
'location_name' => '<string>',
'appointment_type_id' => '<string>',
'appointment_type_name' => '<string>',
'appointment_start' => '<string>',
'appointment_end' => '<string>',
'appointment_duration_minutes' => 123
]
],
'launch' => false,
'allow_duplicates' => false,
'suggested_time_slot' => [
'start' => '<string>',
'end' => '<string>',
'notes' => '<string>'
],
'timezone' => 'America/New_York',
'ehr_source' => 'modmed'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Campaigns
Import Waitlist
Add targets from entries read off the EHR (waitlist, recalls, referrals, upcoming appointments), shaped the way the EHR preview endpoints return them. Each target’s external_id is the entry’s EHR id, so with allow_duplicates false an entry the campaign already holds is skipped.
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
targets
/
import-waitlist
Import Waitlist
curl --request POST \
--url https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist \
--header 'Content-Type: application/json' \
--data '
{
"entries": [
{
"id": "<string>",
"patient_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_date_of_birth": "<string>",
"patient_phone": "<string>",
"added_to_waitlist_at": "<string>",
"note": "<string>",
"source": "waitlist",
"appointment_id": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"appointment_type_id": "<string>",
"appointment_type_name": "<string>",
"appointment_start": "<string>",
"appointment_end": "<string>",
"appointment_duration_minutes": 123
}
],
"launch": false,
"allow_duplicates": false,
"suggested_time_slot": {
"start": "<string>",
"end": "<string>",
"notes": "<string>"
},
"timezone": "America/New_York",
"ehr_source": "modmed"
}
'import requests
url = "https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist"
payload = {
"entries": [
{
"id": "<string>",
"patient_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_date_of_birth": "<string>",
"patient_phone": "<string>",
"added_to_waitlist_at": "<string>",
"note": "<string>",
"source": "waitlist",
"appointment_id": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"appointment_type_id": "<string>",
"appointment_type_name": "<string>",
"appointment_start": "<string>",
"appointment_end": "<string>",
"appointment_duration_minutes": 123
}
],
"launch": False,
"allow_duplicates": False,
"suggested_time_slot": {
"start": "<string>",
"end": "<string>",
"notes": "<string>"
},
"timezone": "America/New_York",
"ehr_source": "modmed"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
entries: [
{
id: '<string>',
patient_id: '<string>',
patient_first_name: '<string>',
patient_last_name: '<string>',
patient_date_of_birth: '<string>',
patient_phone: '<string>',
added_to_waitlist_at: '<string>',
note: '<string>',
source: 'waitlist',
appointment_id: '<string>',
provider_id: '<string>',
provider_name: '<string>',
location_id: '<string>',
location_name: '<string>',
appointment_type_id: '<string>',
appointment_type_name: '<string>',
appointment_start: '<string>',
appointment_end: '<string>',
appointment_duration_minutes: 123
}
],
launch: false,
allow_duplicates: false,
suggested_time_slot: {start: '<string>', end: '<string>', notes: '<string>'},
timezone: 'America/New_York',
ehr_source: 'modmed'
})
};
fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist', 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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist",
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([
'entries' => [
[
'id' => '<string>',
'patient_id' => '<string>',
'patient_first_name' => '<string>',
'patient_last_name' => '<string>',
'patient_date_of_birth' => '<string>',
'patient_phone' => '<string>',
'added_to_waitlist_at' => '<string>',
'note' => '<string>',
'source' => 'waitlist',
'appointment_id' => '<string>',
'provider_id' => '<string>',
'provider_name' => '<string>',
'location_id' => '<string>',
'location_name' => '<string>',
'appointment_type_id' => '<string>',
'appointment_type_name' => '<string>',
'appointment_start' => '<string>',
'appointment_end' => '<string>',
'appointment_duration_minutes' => 123
]
],
'launch' => false,
'allow_duplicates' => false,
'suggested_time_slot' => [
'start' => '<string>',
'end' => '<string>',
'notes' => '<string>'
],
'timezone' => 'America/New_York',
'ehr_source' => 'modmed'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/targets/import-waitlist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"id\": \"<string>\",\n \"patient_id\": \"<string>\",\n \"patient_first_name\": \"<string>\",\n \"patient_last_name\": \"<string>\",\n \"patient_date_of_birth\": \"<string>\",\n \"patient_phone\": \"<string>\",\n \"added_to_waitlist_at\": \"<string>\",\n \"note\": \"<string>\",\n \"source\": \"waitlist\",\n \"appointment_id\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"provider_name\": \"<string>\",\n \"location_id\": \"<string>\",\n \"location_name\": \"<string>\",\n \"appointment_type_id\": \"<string>\",\n \"appointment_type_name\": \"<string>\",\n \"appointment_start\": \"<string>\",\n \"appointment_end\": \"<string>\",\n \"appointment_duration_minutes\": 123\n }\n ],\n \"launch\": false,\n \"allow_duplicates\": false,\n \"suggested_time_slot\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"timezone\": \"America/New_York\",\n \"ehr_source\": \"modmed\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
The ID of the campaign to add targets to.
Body
application/json
entries
(WaitlistImportTargetEntry · object | ReferralImportTargetEntry · object | RecallImportTargetEntry · object | AppointmentImportTargetEntry · object | LeadImportTargetEntry · object)[]
required
Queue entries to import — fetched by the frontend from the integrations service.
An entry off the EHR's appointment waitlist, with the slot it is waiting on.
- WaitlistImportTargetEntry
- ReferralImportTargetEntry
- RecallImportTargetEntry
- AppointmentImportTargetEntry
- LeadImportTargetEntry
Show child attributes
Show child attributes
Whether to launch the imported targets immediately or only add them.
When False, entries already imported (matched on external_id) are skipped.
Slot the agent should pitch on every imported call. Stored on each target's input_data.
Show child attributes
Show child attributes
IANA timezone every imported time is rendered in — the agent's, so the strings on the target read the way the agent will say them. Defaults to US/Eastern.
Example:
"America/New_York"
EHR the entries came from — stamps each target's external_id prefix and the patient's extra_data.ehr_source.
Available options:
eclinicalworks, modmed, athenapractice, drchrono, athenahealth, modmedapi, athenaone, ggastro, veradigm, prosper_ehr, greenway_intergy, nextgen, nextech, nextech_practice_plus, orchestrator_cerner, advancedmd, erad, ezderm, exa, carecloud, elation Response
Successful Response