Skip to main content
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
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Body

application/json

Scheduled Task

​
connection_id
string
required
​
entity_type
enum<string>
required
Available options:
events,
invoice,
credit_topups,
credit_usage,
usage_analytics
​
interval
enum<string>
required
Available options:
15MIN,
30MIN,
custom,
hourly,
daily
​
job_config
object
required
​
enabled
boolean

Response

Created

​
connection_id
string
​
created_at
string<date-time>
​
enabled
boolean
​
entity_type
enum<string>
Available options:
events,
invoice,
credit_topups,
credit_usage,
usage_analytics
​
environment_id
string
​
id
string
​
interval
enum<string>
Available options:
15MIN,
30MIN,
custom,
hourly,
daily
​
job_config
object
​
status
string
​
tenant_id
string
​
updated_at
string<date-time>