Change a table's refresh cadence

curl --request PATCH \
  --url https://api.getoneprofile.ai/tables/{table_id}/schedule/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delete_missing_rows": true,
  "hour": 11,
  "interval_value": 182,
  "minute": 29,
  "paused": true,
  "time_zone": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/schedule/"

payload = {
    "delete_missing_rows": True,
    "hour": 11,
    "interval_value": 182,
    "minute": 29,
    "paused": True,
    "time_zone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    delete_missing_rows: true,
    hour: 11,
    interval_value: 182,
    minute: 29,
    paused: true,
    time_zone: '<string>'
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/schedule/', 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.getoneprofile.ai/tables/{table_id}/schedule/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'delete_missing_rows' => true,
    'hour' => 11,
    'interval_value' => 182,
    'minute' => 29,
    'paused' => true,
    'time_zone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getoneprofile.ai/tables/{table_id}/schedule/"

	payload := strings.NewReader("{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.getoneprofile.ai/tables/{table_id}/schedule/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/schedule/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "delete_missing_rows": true,
  "frequency": "daily",
  "hour": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interval_unit": "days",
  "interval_value": 123,
  "last_skip_reason": "source_detached",
  "last_skipped_at": "2023-11-07T05:31:56Z",
  "minute": 123,
  "next_run_at": "2023-11-07T05:31:56Z",
  "next_runs": [
    "2023-11-07T05:31:56Z"
  ],
  "paused": true,
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "time_zone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

PATCH

tables

{table_id}

schedule

Change a table's refresh cadence

curl --request PATCH \
  --url https://api.getoneprofile.ai/tables/{table_id}/schedule/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delete_missing_rows": true,
  "hour": 11,
  "interval_value": 182,
  "minute": 29,
  "paused": true,
  "time_zone": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/schedule/"

payload = {
    "delete_missing_rows": True,
    "hour": 11,
    "interval_value": 182,
    "minute": 29,
    "paused": True,
    "time_zone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    delete_missing_rows: true,
    hour: 11,
    interval_value: 182,
    minute: 29,
    paused: true,
    time_zone: '<string>'
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/schedule/', 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.getoneprofile.ai/tables/{table_id}/schedule/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'delete_missing_rows' => true,
    'hour' => 11,
    'interval_value' => 182,
    'minute' => 29,
    'paused' => true,
    'time_zone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getoneprofile.ai/tables/{table_id}/schedule/"

	payload := strings.NewReader("{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.getoneprofile.ai/tables/{table_id}/schedule/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/schedule/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"delete_missing_rows\": true,\n  \"hour\": 11,\n  \"interval_value\": 182,\n  \"minute\": 29,\n  \"paused\": true,\n  \"time_zone\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "delete_missing_rows": true,
  "frequency": "daily",
  "hour": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interval_unit": "days",
  "interval_value": 123,
  "last_skip_reason": "source_detached",
  "last_skipped_at": "2023-11-07T05:31:56Z",
  "minute": 123,
  "next_run_at": "2023-11-07T05:31:56Z",
  "next_runs": [
    "2023-11-07T05:31:56Z"
  ],
  "paused": true,
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "time_zone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id

string<uuid>

required

Body

application/json

Change a table's cadence. Every field is optional.

delete_missing_rows

boolean | null

frequency

enum<string> | null

How often a table re-imports, in the vocabulary the settings panel offers.

The four presets are stored as cron because "the 8th of every month at 09:00" is a calendar statement that an interval cannot make — an interval of 30 days drifts off the date within a year. CUSTOM is the escape hatch for "every N days/weeks/months", which is an interval and drifts on purpose, anchored to when the user set it up.

Available options:

daily,

weekly,

monthly,

quarterly,

custom

hour

integer | null

Required range: 0 <= x <= 23

interval_unit

enum<string> | null

The unit a CUSTOM cadence counts in.

Available options:

days,

weeks,

months

interval_value

integer | null

Required range: 0 < x <= 365

minute

integer | null

Required range: 0 <= x <= 59

paused

boolean | null

time_zone

string | null

Maximum string length: 64

Response

Successful Response

A table's refresh cadence.

created_at

string<date-time>

required

delete_missing_rows

boolean

required

Whether a scheduled run deletes rows whose records are gone from the source. Forces every scheduled run to re-list everything, since a changes-only fetch cannot tell a deleted record from an unchanged one.

frequency

enum<string>

required

How often a table re-imports, in the vocabulary the settings panel offers.

Available options:

daily,

weekly,

monthly,

quarterly,

custom

hour

integer

required

Local hour the cadence runs at.

string<uuid>

required

interval_unit

enum<string> | null

required

The unit a CUSTOM cadence counts in.

Available options:

days,

weeks,

months

interval_value

integer | null

required

How many units apart, for a custom cadence.

last_skip_reason

enum<string> | null

required

Why the last firing skipped, alongside last_skipped_at.

Available options:

source_detached,

run_in_progress

last_skipped_at

string<date-time> | null

required

When a firing last skipped without starting a run; null if it never has.

minute

integer

required

Local minute the cadence runs at.

next_run_at

string<date-time>

required

next_runs

string<date-time>[]

required

The next few fire times, so a cadence can be checked before it is trusted.

paused

boolean

required

table_id

string<uuid>

required

time_zone

string

required

IANA zone the run time is expressed in.

updated_at

string<date-time>

required

API reference

Endpoints

Change a table's refresh cadence

Authorizations

Path Parameters

Body

Response