Skip to main content
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>",
  "environment_id": "<string>",
  "error_summary": "<string>",
  "failed_at": "2023-11-07T05:31:56Z",
  "failed_records": 123,
  "file_name": "<string>",
  "file_url": "<string>",
  "id": "<string>",
  "metadata": {},
  "processed_records": 123,
  "scheduled_task_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "successful_records": 123,
  "tenant_id": "<string>",
  "total_records": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "workflow_id": "<string>"
}
{
"http_status_code": 123,
"message": "<string>"
}
{
"http_status_code": 123,
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Task configuration

entity_type
enum<string>
required
Available options:
EVENTS,
PRICES,
CUSTOMERS,
FEATURES
file_type
enum<string>
required
Available options:
CSV,
JSON
file_url
string
required
task_type
enum<string>
required
Available options:
IMPORT,
EXPORT
file_name
string
metadata
object

Response

Accepted

completed_at
string<date-time>
created_at
string<date-time>
created_by
string
entity_type
enum<string>
Available options:
EVENTS,
PRICES,
CUSTOMERS,
FEATURES
environment_id
string
error_summary
string
failed_at
string<date-time>
failed_records
integer
file_name
string
file_type
enum<string>
Available options:
CSV,
JSON
file_url
string
id
string
metadata
object
processed_records
integer
scheduled_task_id
string
started_at
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
successful_records
integer
task_status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
task_type
enum<string>
Available options:
IMPORT,
EXPORT
tenant_id
string
total_records
integer
updated_at
string<date-time>
updated_by
string
workflow_id
string