Create a new task
curl --request POST \
--url https://us.api.flexprice.io/v1/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file_url": "<string>",
"file_name": "<string>",
"metadata": {}
}
'import requests
url = "https://us.api.flexprice.io/v1/tasks"
payload = {
"file_url": "<string>",
"file_name": "<string>",
"metadata": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({file_url: '<string>', file_name: '<string>', metadata: {}})
};
fetch('https://us.api.flexprice.io/v1/tasks', 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://us.api.flexprice.io/v1/tasks",
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([
'file_url' => '<string>',
'file_name' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/tasks"
payload := strings.NewReader("{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/tasks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"entity_type": "EVENTS",
"environment_id": "<string>",
"error_summary": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_records": 123,
"file_name": "<string>",
"file_type": "CSV",
"file_url": "<string>",
"id": "<string>",
"metadata": {},
"processed_records": 123,
"scheduled_task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "published",
"successful_records": 123,
"task_status": "PENDING",
"task_type": "IMPORT",
"tenant_id": "<string>",
"total_records": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"workflow_id": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Tasks
Create a new task
Use when submitting a file or job for async processing (e.g. export or import). Returns task ID to poll for status and result.
POST
/
tasks
Create a new task
curl --request POST \
--url https://us.api.flexprice.io/v1/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file_url": "<string>",
"file_name": "<string>",
"metadata": {}
}
'import requests
url = "https://us.api.flexprice.io/v1/tasks"
payload = {
"file_url": "<string>",
"file_name": "<string>",
"metadata": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({file_url: '<string>', file_name: '<string>', metadata: {}})
};
fetch('https://us.api.flexprice.io/v1/tasks', 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://us.api.flexprice.io/v1/tasks",
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([
'file_url' => '<string>',
'file_name' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/tasks"
payload := strings.NewReader("{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/tasks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"entity_type": "EVENTS",
"environment_id": "<string>",
"error_summary": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_records": 123,
"file_name": "<string>",
"file_type": "CSV",
"file_url": "<string>",
"id": "<string>",
"metadata": {},
"processed_records": 123,
"scheduled_task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "published",
"successful_records": 123,
"task_status": "PENDING",
"task_type": "IMPORT",
"tenant_id": "<string>",
"total_records": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"workflow_id": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Task configuration
Response
Accepted
Available options:
EVENTS, PRICES, CUSTOMERS, FEATURES Available options:
CSV, JSON Available options:
published, deleted, archived Available options:
PENDING, PROCESSING, COMPLETED, FAILED Available options:
IMPORT, EXPORT 
