Trigger an import job for processing · Email

infoOverview

About this API

Triggers a pending import job to start processing. The import job must be in PENDING status. Once triggered, the job status will change to QUEUED and will be processed by the worker.

MethodPOST

Versionv1.0

Get Test URL Get Test API Key

Content Typeapplication/json

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameAuthorization: Bearer <TOKEN>

Example valueYOUR_ACCESS_TOKEN

routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

groupIdstringRequiredUnique identifier of the group associated with the import job.

idstringRequiredUnique identifier of the import job to trigger.

uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

{}

{
  "type": "object",
  "required": [
    "groupId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier of the import job to trigger.",
      "x-parameter-in": "path"
    },
    "groupId": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier of the group associated with the import job.",
      "x-parameter-in": "path"
    }
  }
}

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request POST 'https://email.1spoc.com/api/user/imports/{groupId}/{id}/trigger' \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const response = await fetch('https://email.1spoc.com/api/user/imports/{groupId}/{id}/trigger', {
  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}/{id}/trigger', {
  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}/{id}/trigger'
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}/{id}/trigger"))
    .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}/{id}/trigger',
    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}/{id}/trigger", 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}/{id}/trigger", 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))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}

{
  "type": "object",
  "example": {
    "message": "Import job triggered successfully."
  },
  "properties": {
    "message": {
      "type": "string",
      "example": "Import job triggered successfully."
    }
  }
}

ruleHTTP Responses

Status Codes

200Import job triggered successfully.

400Bad request - import job is not pending or missing id

401Unauthorized (missing or invalid user access token)

404User or import job not found

500Internal server error