Batch Create Contact Lists
Create contact lists in batch (up to 100 items per request).
Unlike single-resource POST endpoints, the body wraps the payloads in
items and the response reports a per-item status.
Requires the contact_lists:write scope on the API key.
POST
/
v1
/
contact-lists
Batch Create Contact Lists
curl --request POST \
--url https://api.topo.io/v1/contact-lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
default_sequence_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.topo.io/v1/contact-lists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contact-lists"
payload = { "items": [
{
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"items": [
{
"index": 123,
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_sequence_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"error": {
"type": "<string>",
"message": "<string>"
}
}
],
"summary": {
"total": 123,
"succeeded": 123,
"failed": 123
}
}Authorizations
Bearer API key issued from Settings → Developers.
Body
application/json
Batch Create Contact Lists payload
Response
200 - application/json
Successful Response
Hide child attributes
Hide child attributes
Available options:
CREATED, UPDATED, FAILED Hide child attributes
Hide child attributes
Unique identifier.
Name of the list.
Default sequence template for new entries.
Current number of entries in the list.
When the list was created.
When the list last changed.
Was this page helpful?
⌘I
Batch Create Contact Lists
curl --request POST \
--url https://api.topo.io/v1/contact-lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
default_sequence_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.topo.io/v1/contact-lists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contact-lists"
payload = { "items": [
{
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"items": [
{
"index": 123,
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_sequence_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"error": {
"type": "<string>",
"message": "<string>"
}
}
],
"summary": {
"total": 123,
"succeeded": 123,
"failed": 123
}
}