Campaign audience
Create contact list
Create a contact list and get a presigned URL for uploading its CSV file.
POST
/
v1
/
calls
/
contact-lists
Create contact list and get presigned upload URL
curl --request POST \
--url https://api.persistence.dev/v1/calls/contact-lists \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fileName": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/contact-lists"
payload = {
"fileName": "<string>",
"name": "<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({fileName: '<string>', name: '<string>'})
};
fetch('https://api.persistence.dev/v1/calls/contact-lists', 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.persistence.dev/v1/calls/contact-lists",
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([
'fileName' => '<string>',
'name' => '<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.persistence.dev/v1/calls/contact-lists"
payload := strings.NewReader("{\n \"fileName\": \"<string>\",\n \"name\": \"<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.persistence.dev/v1/calls/contact-lists")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileName\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/contact-lists")
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 \"fileName\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "<string>",
"id": "<string>",
"name": "<string>",
"s3Key": "<string>",
"status": "ready",
"totalEntries": 123,
"type": "contacts",
"updatedAt": "<string>",
"uploadDetails": {
"errorReportS3Key": "<string>",
"errorReportUrl": "<string>",
"errors": [
123
],
"id": "<string>",
"metadata": {
"duplicateRows": 123,
"importedRows": 123,
"invalidRows": 123,
"totalRows": 123,
"validRows": 123
},
"processedAt": "<string>",
"s3Key": "<string>",
"status": "uploaded",
"uploadedAt": "<string>",
"validatedAt": "<string>"
},
"uploadHeaders": {},
"uploadUrl": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}Authorizations
API key issued for your workspace.
Body
application/json
Contact list creation request with file name
Response
Created
Available options:
ready, draft, archived Available options:
contacts, dnd, batch Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Create contact list and get presigned upload URL
curl --request POST \
--url https://api.persistence.dev/v1/calls/contact-lists \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fileName": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/contact-lists"
payload = {
"fileName": "<string>",
"name": "<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({fileName: '<string>', name: '<string>'})
};
fetch('https://api.persistence.dev/v1/calls/contact-lists', 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.persistence.dev/v1/calls/contact-lists",
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([
'fileName' => '<string>',
'name' => '<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.persistence.dev/v1/calls/contact-lists"
payload := strings.NewReader("{\n \"fileName\": \"<string>\",\n \"name\": \"<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.persistence.dev/v1/calls/contact-lists")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileName\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/contact-lists")
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 \"fileName\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "<string>",
"id": "<string>",
"name": "<string>",
"s3Key": "<string>",
"status": "ready",
"totalEntries": 123,
"type": "contacts",
"updatedAt": "<string>",
"uploadDetails": {
"errorReportS3Key": "<string>",
"errorReportUrl": "<string>",
"errors": [
123
],
"id": "<string>",
"metadata": {
"duplicateRows": 123,
"importedRows": 123,
"invalidRows": 123,
"totalRows": 123,
"validRows": 123
},
"processedAt": "<string>",
"s3Key": "<string>",
"status": "uploaded",
"uploadedAt": "<string>",
"validatedAt": "<string>"
},
"uploadHeaders": {},
"uploadUrl": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}