curl --request POST \
--url https://api.superx.so/v1/datasets/{id}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"list_id": "cl_9f2b71"
}
'import requests
url = "https://api.superx.so/v1/datasets/{id}/contacts"
payload = { "list_id": "cl_9f2b71" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({list_id: 'cl_9f2b71'})
};
fetch('https://api.superx.so/v1/datasets/{id}/contacts', 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.superx.so/v1/datasets/{id}/contacts",
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([
'list_id' => 'cl_9f2b71'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.superx.so/v1/datasets/{id}/contacts"
payload := strings.NewReader("{\n \"list_id\": \"cl_9f2b71\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.superx.so/v1/datasets/{id}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"list_id\": \"cl_9f2b71\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superx.so/v1/datasets/{id}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"list_id\": \"cl_9f2b71\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"added": 198,
"duplicates": 12,
"failed": 0,
"skipped_without_id": 4,
"total_in_list_after": 242
}
}{
"error": {
"code": "dataset_has_no_people",
"message": "This dataset has no people to add: own-content datasets hold your posts, and rows without an X account id are skipped."
}
}{
"error": {
"code": "invalid_api_key",
"message": "Unknown or revoked API key"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key is read-only. Create a key with the write scope to use this endpoint."
}
}{
"error": {
"code": "list_not_found",
"message": "No contact list with that id belongs to this account."
}
}{
"error": {
"code": "dataset_not_ready",
"message": "This dataset is not ready yet. Check GET /v1/datasets/{id}: a collecting dataset finishes on its own, and a failed one has to be rebuilt in the SuperX app.",
"dataset_status": "collecting"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for the Pro plan (30 requests/min). Upgrade for higher limits.",
"retry_after": 42
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch scheduled posts. Try again shortly."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The scheduling service is temporarily unavailable. Retry with the same Idempotency-Key."
}
}Add a dataset's people to a contact list
Copy the people in a ready dataset into a contact list you created.
Costs ONE WRITE and no enrichment: the profiles come from the dataset the collection already hydrated, which is why people SuperX has never stored still land in the list.
People are deduped by X account id before the write, and rows without
an X account id or a usable handle are counted in
skipped_without_id rather than added as blank members, so
added + duplicates can be lower than the dataset’s row_count.
Re-running is safe: people already in the list come back in
duplicates.
Own-content datasets (your posts, your replies) hold no people and
return 400 dataset_has_no_people; so does a dataset whose rows all
lack an X account id. A dataset that is not ready returns 409
dataset_not_ready, and a system list returns 400
system_list_read_only.
Works for your main account or any account linked to it
(account_id); accounts shared with you are read-only. Needs the
write scope.
curl --request POST \
--url https://api.superx.so/v1/datasets/{id}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"list_id": "cl_9f2b71"
}
'import requests
url = "https://api.superx.so/v1/datasets/{id}/contacts"
payload = { "list_id": "cl_9f2b71" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({list_id: 'cl_9f2b71'})
};
fetch('https://api.superx.so/v1/datasets/{id}/contacts', 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.superx.so/v1/datasets/{id}/contacts",
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([
'list_id' => 'cl_9f2b71'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.superx.so/v1/datasets/{id}/contacts"
payload := strings.NewReader("{\n \"list_id\": \"cl_9f2b71\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.superx.so/v1/datasets/{id}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"list_id\": \"cl_9f2b71\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superx.so/v1/datasets/{id}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"list_id\": \"cl_9f2b71\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"added": 198,
"duplicates": 12,
"failed": 0,
"skipped_without_id": 4,
"total_in_list_after": 242
}
}{
"error": {
"code": "dataset_has_no_people",
"message": "This dataset has no people to add: own-content datasets hold your posts, and rows without an X account id are skipped."
}
}{
"error": {
"code": "invalid_api_key",
"message": "Unknown or revoked API key"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key is read-only. Create a key with the write scope to use this endpoint."
}
}{
"error": {
"code": "list_not_found",
"message": "No contact list with that id belongs to this account."
}
}{
"error": {
"code": "dataset_not_ready",
"message": "This dataset is not ready yet. Check GET /v1/datasets/{id}: a collecting dataset finishes on its own, and a failed one has to be rebuilt in the SuperX app.",
"dataset_status": "collecting"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for the Pro plan (30 requests/min). Upgrade for higher limits.",
"retry_after": 42
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch scheduled posts. Try again shortly."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The scheduling service is temporarily unavailable. Retry with the same Idempotency-Key."
}
}Authorizations
A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets.
Path Parameters
The dataset id from GET /v1/datasets.
^[A-Za-z0-9_-]{1,64}$Body
Response
The add finished. Read the counters for what happened.
Show child attributes
Show child attributes