Create a schedule

curl --request POST \
  --url https://api.stackone.com/v2/data_sync/schedules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action_id": "hris_list_employees",
  "sync_params": {
    "path": {},
    "query": {},
    "body": {},
    "headers": {}
  },
  "name": "<string>",
  "enabled": true,
  "cadence": "<string>",
  "full_sync_after": "<string>",
  "start_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.stackone.com/v2/data_sync/schedules"

payload = {
    "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "action_id": "hris_list_employees",
    "sync_params": {
        "path": {},
        "query": {},
        "body": {},
        "headers": {}
    },
    "name": "<string>",
    "enabled": True,
    "cadence": "<string>",
    "full_sync_after": "<string>",
    "start_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    action_id: 'hris_list_employees',
    sync_params: {path: {}, query: {}, body: JSON.stringify({}), headers: {}},
    name: '<string>',
    enabled: true,
    cadence: '<string>',
    full_sync_after: '<string>',
    start_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.stackone.com/v2/data_sync/schedules', 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://api.stackone.com/v2/data_sync/schedules",
  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([
    'account_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'action_id' => 'hris_list_employees',
    'sync_params' => [
        'path' => [
                
        ],
        'query' => [
                
        ],
        'body' => [
                
        ],
        'headers' => [
                
        ]
    ],
    'name' => '<string>',
    'enabled' => true,
    'cadence' => '<string>',
    'full_sync_after' => '<string>',
    'start_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://api.stackone.com/v2/data_sync/schedules"

	payload := strings.NewReader("{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://api.stackone.com/v2/data_sync/schedules")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/v2/data_sync/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "account_id": "<string>",
  "action_id": "<string>",
  "name": "<string>",
  "sync_params": {
    "path": {},
    "query": {},
    "body": {},
    "headers": {}
  },
  "params_hash": "<string>",
  "enabled": true,
  "cadence": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sync_config_id": "<string>",
  "source": "auto_link",
  "full_sync_after": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "last_run_error": "<string>",
  "paused_reason": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

POST

data_sync

schedules

Create a schedule

curl --request POST \
  --url https://api.stackone.com/v2/data_sync/schedules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action_id": "hris_list_employees",
  "sync_params": {
    "path": {},
    "query": {},
    "body": {},
    "headers": {}
  },
  "name": "<string>",
  "enabled": true,
  "cadence": "<string>",
  "full_sync_after": "<string>",
  "start_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.stackone.com/v2/data_sync/schedules"

payload = {
    "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "action_id": "hris_list_employees",
    "sync_params": {
        "path": {},
        "query": {},
        "body": {},
        "headers": {}
    },
    "name": "<string>",
    "enabled": True,
    "cadence": "<string>",
    "full_sync_after": "<string>",
    "start_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    action_id: 'hris_list_employees',
    sync_params: {path: {}, query: {}, body: JSON.stringify({}), headers: {}},
    name: '<string>',
    enabled: true,
    cadence: '<string>',
    full_sync_after: '<string>',
    start_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.stackone.com/v2/data_sync/schedules', 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://api.stackone.com/v2/data_sync/schedules",
  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([
    'account_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'action_id' => 'hris_list_employees',
    'sync_params' => [
        'path' => [
                
        ],
        'query' => [
                
        ],
        'body' => [
                
        ],
        'headers' => [
                
        ]
    ],
    'name' => '<string>',
    'enabled' => true,
    'cadence' => '<string>',
    'full_sync_after' => '<string>',
    'start_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://api.stackone.com/v2/data_sync/schedules"

	payload := strings.NewReader("{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://api.stackone.com/v2/data_sync/schedules")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/v2/data_sync/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"action_id\": \"hris_list_employees\",\n  \"sync_params\": {\n    \"path\": {},\n    \"query\": {},\n    \"body\": {},\n    \"headers\": {}\n  },\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"cadence\": \"<string>\",\n  \"full_sync_after\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "account_id": "<string>",
  "action_id": "<string>",
  "name": "<string>",
  "sync_params": {
    "path": {},
    "query": {},
    "body": {},
    "headers": {}
  },
  "params_hash": "<string>",
  "enabled": true,
  "cadence": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sync_config_id": "<string>",
  "source": "auto_link",
  "full_sync_after": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "last_run_error": "<string>",
  "paused_reason": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

account_id

string

required

The linked account to sync.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

action_id

string

required

The action to sync. The account's connector profile must already have a sync config for it.

Example:

"hris_list_employees"

sync_params

object | null

The parameters the action is called with on each run. Every parameter the action requires must be supplied; call GET /v2/data_sync/sync_configs/{id}/parameters to discover them.

Show child attributes

name

string | null

A human-readable name for the schedule. Defaults to the action id.

enabled

boolean | null

default:true

Whether the schedule is active on creation.

cadence

string | null

How often the sync fires. ISO 8601 duration (e.g. PT1H); inherited from the sync config when omitted.

full_sync_after

string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration; inherited from the sync config when omitted.

start_at

string<date-time> | null

When the schedule should first fire; null for no start time, omit to inherit it from the sync config.

Response

The schedule was created.

string

required

The unique identifier of the schedule.

account_id

string

required

The linked account this schedule syncs.

action_id

string

required

The action this schedule runs.

name

string

required

The human-readable name of the schedule.

sync_params

object

required

The parameters the action is called with on each run.

Show child attributes

params_hash

string

required

A hash of sync_params, distinguishing schedules for the same action.

enabled

boolean

required

Whether the schedule is currently active.

cadence

string

required

How often the sync fires. ISO 8601 duration. Owned by the sync config on auto_link schedules — patching it there is rejected.

created_at

string<date-time>

required

When the schedule was created.

updated_at

string<date-time>

required

When the schedule was last updated.

sync_config_id

string | null

The sync config that bounds this schedule. Set on every schedule, hand-authored ones included — it is what permits the action to sync at all. Use source to tell how a schedule came to exist; null here means only that the schedule predates the field.

source

enum<string> | null

How the schedule came to exist: auto_link if its sync config fanned it out, manual if it was hand-authored. This is the discriminator between the two, not sync_config_id. It also decides which fields are patchable: an auto_link schedule takes cadence, start_at and full_sync_after from its sync config.

Available options:

auto_link,

manual,

unmapped_value,

null

full_sync_after

string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration; null when unset. Owned by the sync config on auto_link schedules — patching it there is rejected.

start_at

string<date-time> | null

When the schedule was first scheduled to fire; null when unset. Owned by the sync config on auto_link schedules — patching it there is rejected.

next_run_at

string<date-time> | null

When the schedule will next fire; null when unset.

last_run_at

string<date-time> | null

When the schedule last ran; null before its first run.

last_run_status

string | null

The status of the most recent run; null before its first run.

last_run_error

string | null

The error message from the most recent run, if it failed.

paused_reason

string | null

Why the schedule is not currently running even though enabled may be true. sync_config_disabled while its sync config is disabled or has been removed, action_disabled while the action is switched off on the connector profile, auto_link_disabled while auto_link is off on a schedule that auto_link created (hand-authored schedules are unaffected by it), or an account-lifecycle reason such as the linked account being disabled. Only the widest cause currently holding the schedule back is reported, so clearing it may reveal another. The schedule keeps its own enabled value throughout. null means nothing is holding it back.

Accounts

Actions

Connect Sessions

Connector Profiles

Connectors

Data Sync

Logs

MCP

Webhooks

Create a schedule

Authorizations

Body

Response