Create scheduled task
curl --request POST \
--url https://us.api.flexprice.io/v1/tasks/scheduled \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connection_id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"enabled": true
}
'import requests
url = "https://us.api.flexprice.io/v1/tasks/scheduled"
payload = {
"connection_id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": True
},
"enabled": True
}
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({
connection_id: '<string>',
job_config: {
bucket: '<string>',
endpoint_url: '<string>',
export_metadata_fields: [{field_key: '<string>', column_name: '<string>'}],
key_prefix: '<string>',
region: '<string>',
use_path_style: true
},
enabled: true
})
};
fetch('https://us.api.flexprice.io/v1/tasks/scheduled', 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/scheduled",
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([
'connection_id' => '<string>',
'job_config' => [
'bucket' => '<string>',
'endpoint_url' => '<string>',
'export_metadata_fields' => [
[
'field_key' => '<string>',
'column_name' => '<string>'
]
],
'key_prefix' => '<string>',
'region' => '<string>',
'use_path_style' => true
],
'enabled' => true
]),
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/scheduled"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\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/scheduled")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/tasks/scheduled")
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 \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"connection_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"environment_id": "<string>",
"id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}Scheduled Tasks
Create scheduled task
Use when setting up recurring data exports or other scheduled jobs. Ideal for report generation or syncing data on a schedule.
POST
/
tasks
/
scheduled
Create scheduled task
curl --request POST \
--url https://us.api.flexprice.io/v1/tasks/scheduled \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connection_id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"enabled": true
}
'import requests
url = "https://us.api.flexprice.io/v1/tasks/scheduled"
payload = {
"connection_id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": True
},
"enabled": True
}
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({
connection_id: '<string>',
job_config: {
bucket: '<string>',
endpoint_url: '<string>',
export_metadata_fields: [{field_key: '<string>', column_name: '<string>'}],
key_prefix: '<string>',
region: '<string>',
use_path_style: true
},
enabled: true
})
};
fetch('https://us.api.flexprice.io/v1/tasks/scheduled', 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/scheduled",
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([
'connection_id' => '<string>',
'job_config' => [
'bucket' => '<string>',
'endpoint_url' => '<string>',
'export_metadata_fields' => [
[
'field_key' => '<string>',
'column_name' => '<string>'
]
],
'key_prefix' => '<string>',
'region' => '<string>',
'use_path_style' => true
],
'enabled' => true
]),
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/scheduled"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\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/scheduled")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/tasks/scheduled")
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 \"connection_id\": \"<string>\",\n \"job_config\": {\n \"bucket\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"export_metadata_fields\": [\n {\n \"field_key\": \"<string>\",\n \"column_name\": \"<string>\"\n }\n ],\n \"key_prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"use_path_style\": true\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"connection_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"environment_id": "<string>",
"id": "<string>",
"job_config": {
"bucket": "<string>",
"endpoint_url": "<string>",
"export_metadata_fields": [
{
"field_key": "<string>",
"column_name": "<string>"
}
],
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Scheduled Task
Response
Created
Available options:
events, invoice, credit_topups, credit_usage, usage_analytics Available options:
15MIN, 30MIN, custom, hourly, daily Show child attributes
Show child attributes
⌘I

