About this API
Creates an import job for a specific group and returns a presigned URL for uploading a CSV file. The file must be a CSV file.
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Authorization: Bearer <TOKEN>YOUR_ACCESS_TOKENPath Parameters
Substitute these placeholders in the endpoint URL before sending the request.
groupIdstringRequiredResource identifier for groupId.Request Body
Send a application/json payload. Replace placeholder values with data from your integration.
Top-Level Fields
file_typestringRequiredMIME type of the file.original_namestringRequiredOriginal name of the file to be imported.{}
{
"type": "object",
"required": [
"original_name",
"file_type"
],
"properties": {
"file_type": {
"type": "string",
"example": "text/csv",
"description": "MIME type of the file."
},
"original_name": {
"type": "string",
"example": "contacts.csv",
"description": "Original name of the file to be imported."
}
}
}
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
curl --request POST 'https://email.1spoc.com/api/user/imports/{groupId}' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{}'
const response = await fetch('https://email.1spoc.com/api/user/imports/{groupId}', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://email.1spoc.com/api/user/imports/{groupId}', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests
url = 'https://email.1spoc.com/api/user/imports/{groupId}'
headers = {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
}
payload = json.loads(r'''{}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
String body = """
{}
""";
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/imports/{groupId}"))
.header("Authorization", "Bearer <TOKEN>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{}';
curl_setopt_array($curl, [
CURLOPT_URL => 'https://email.1spoc.com/api/user/imports/{groupId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>","Content-Type: application/json"],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var json = """
{}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://email.1spoc.com/api/user/imports/{groupId}", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"bytes"
)
func main() {
request, err := http.NewRequest("POST", "https://email.1spoc.com/api/user/imports/{groupId}", bytes.NewBufferString("{}"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Accept", "application/json")
request.Header.Set("Authorization", "Bearer <TOKEN>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{}
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Presigned URL for uploading the CSV file to S3."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the import job."
},
"user_id": {
"type": "string",
"format": "uuid",
"description": "ID of the user who created the import job."
},
"admin_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "ID of the admin associated with the user."
},
"file_key": {
"type": "string",
"description": "S3 key where the file will be stored."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the import job was created."
},
"original_name": {
"type": "string",
"description": "Original name of the file."
}
}
},
"message": {
"type": "string",
"example": "Import job created successfully."
}
}
}
Status Codes
201Import job created successfully.400Bad request - missing or invalid input401Unauthorized (missing or invalid user access token)404User not found500Internal server error