curl --request POST \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "csv",
"content": "<string>",
"fileName": "leads.csv",
"columnMapping": [
{
"csvHeader": "Full Name",
"targetColumnId": "<string>"
}
],
"mergeStrategy": "overwrite"
}
}
'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs"
payload = { "data": {
"type": "csv",
"content": "<string>",
"fileName": "leads.csv",
"columnMapping": [
{
"csvHeader": "Full Name",
"targetColumnId": "<string>"
}
],
"mergeStrategy": "overwrite"
} }
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({
data: {
type: 'csv',
content: '<string>',
fileName: 'leads.csv',
columnMapping: [{csvHeader: 'Full Name', targetColumnId: '<string>'}],
mergeStrategy: 'overwrite'
}
})
};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs', 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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs",
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([
'data' => [
'type' => 'csv',
'content' => '<string>',
'fileName' => 'leads.csv',
'columnMapping' => [
[
'csvHeader' => 'Full Name',
'targetColumnId' => '<string>'
]
],
'mergeStrategy' => 'overwrite'
]
]),
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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs")
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 \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "l44e15irdq4db30i77cgphhx",
"type": "csv",
"status": "running",
"totalCount": 1500,
"processedCount": 750,
"addedCount": 700,
"skippedCount": 45,
"failedCount": 5,
"error": "Rate limit exceeded",
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-16T08:00:00.000Z",
"completedAt": "2025-01-16T08:05:00.000Z"
}Create import job
Create a new import job to add leads to the campaign from various sources. The job runs asynchronously in the background — poll the job status endpoint to track progress.
curl --request POST \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "csv",
"content": "<string>",
"fileName": "leads.csv",
"columnMapping": [
{
"csvHeader": "Full Name",
"targetColumnId": "<string>"
}
],
"mergeStrategy": "overwrite"
}
}
'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs"
payload = { "data": {
"type": "csv",
"content": "<string>",
"fileName": "leads.csv",
"columnMapping": [
{
"csvHeader": "Full Name",
"targetColumnId": "<string>"
}
],
"mergeStrategy": "overwrite"
} }
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({
data: {
type: 'csv',
content: '<string>',
fileName: 'leads.csv',
columnMapping: [{csvHeader: 'Full Name', targetColumnId: '<string>'}],
mergeStrategy: 'overwrite'
}
})
};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs', 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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs",
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([
'data' => [
'type' => 'csv',
'content' => '<string>',
'fileName' => 'leads.csv',
'columnMapping' => [
[
'csvHeader' => 'Full Name',
'targetColumnId' => '<string>'
]
],
'mergeStrategy' => 'overwrite'
]
]),
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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\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://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/import-jobs")
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 \"data\": {\n \"type\": \"csv\",\n \"content\": \"<string>\",\n \"fileName\": \"leads.csv\",\n \"columnMapping\": [\n {\n \"csvHeader\": \"Full Name\",\n \"targetColumnId\": \"<string>\"\n }\n ],\n \"mergeStrategy\": \"overwrite\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "l44e15irdq4db30i77cgphhx",
"type": "csv",
"status": "running",
"totalCount": 1500,
"processedCount": 750,
"addedCount": 700,
"skippedCount": 45,
"failedCount": 5,
"error": "Rate limit exceeded",
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-16T08:00:00.000Z",
"completedAt": "2025-01-16T08:05:00.000Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the campaign to import leads into.
^[0-9a-z]+$Body
Import configuration. The type field determines which import source is used and what additional fields are required.
- CSV file import
- Plain text file import
- Import followers
- Import following
- Import tweet likes
- Import retweets
- Import quote tweets
- Import replies
- Import X list members
- Import X list followers
- Import from list
- Import from campaign
Show child attributes
Show child attributes
Response
OK
Unique identifier for the import job.
^[0-9a-z]+$"l44e15irdq4db30i77cgphhx"
The type of importer used for this job.
"csv"
"followers"
"likes"
Current status of the import job. 'queued' means the job is waiting for a slot. 'starting' means a slot has been acquired and execution is about to begin.
queued, starting, running, paused, completed, failed, canceled "running"
"completed"
Total number of items to import, if known.
-9007199254740991 <= x <= 90071992547409911500
Number of items processed so far.
-9007199254740991 <= x <= 9007199254740991750
Number of leads successfully added.
-9007199254740991 <= x <= 9007199254740991700
Number of leads skipped (already exist).
-9007199254740991 <= x <= 900719925474099145
Number of leads that failed to import.
-9007199254740991 <= x <= 90071992547409915
Error message if the job failed.
"Rate limit exceeded"
When the import job was created.
"2025-01-15T10:30:00.000Z"
When the import job was last updated.
"2025-01-16T08:00:00.000Z"
When the import job completed.
"2025-01-16T08:05:00.000Z"
Was this page helpful?