Update a reporting schedule

curl --request PATCH \
  --url https://api.arcuserp.com/v1/reporting-schedules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "<string>",
  "time_zone": "<string>",
  "recipients": [
    "<string>"
  ],
  "message": "<string>",
  "is_active": true
}
'

import requests

url = "https://api.arcuserp.com/v1/reporting-schedules/{id}"

payload = {
    "name": "<string>",
    "day_of_week": 123,
    "day_of_month": 123,
    "send_time": "<string>",
    "time_zone": "<string>",
    "recipients": ["<string>"],
    "message": "<string>",
    "is_active": True
}
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({
    name: '<string>',
    day_of_week: 123,
    day_of_month: 123,
    send_time: '<string>',
    time_zone: '<string>',
    recipients: ['<string>'],
    message: '<string>',
    is_active: true
  })
};

fetch('https://api.arcuserp.com/v1/reporting-schedules/{id}', 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.arcuserp.com/v1/reporting-schedules/{id}",
  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([
    'name' => '<string>',
    'day_of_week' => 123,
    'day_of_month' => 123,
    'send_time' => '<string>',
    'time_zone' => '<string>',
    'recipients' => [
        '<string>'
    ],
    'message' => '<string>',
    'is_active' => true
  ]),
  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.arcuserp.com/v1/reporting-schedules/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\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.arcuserp.com/v1/reporting-schedules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/reporting-schedules/{id}")

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  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "reporting_schedule",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "report_type": "<string>",
  "params": {},
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "<string>",
  "time_zone": "<string>",
  "recipients": [
    "<string>"
  ],
  "message": "<string>",
  "is_active": true,
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

PATCH

reporting-schedules

{id}

Update a reporting schedule

curl --request PATCH \
  --url https://api.arcuserp.com/v1/reporting-schedules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "<string>",
  "time_zone": "<string>",
  "recipients": [
    "<string>"
  ],
  "message": "<string>",
  "is_active": true
}
'

import requests

url = "https://api.arcuserp.com/v1/reporting-schedules/{id}"

payload = {
    "name": "<string>",
    "day_of_week": 123,
    "day_of_month": 123,
    "send_time": "<string>",
    "time_zone": "<string>",
    "recipients": ["<string>"],
    "message": "<string>",
    "is_active": True
}
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({
    name: '<string>',
    day_of_week: 123,
    day_of_month: 123,
    send_time: '<string>',
    time_zone: '<string>',
    recipients: ['<string>'],
    message: '<string>',
    is_active: true
  })
};

fetch('https://api.arcuserp.com/v1/reporting-schedules/{id}', 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.arcuserp.com/v1/reporting-schedules/{id}",
  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([
    'name' => '<string>',
    'day_of_week' => 123,
    'day_of_month' => 123,
    'send_time' => '<string>',
    'time_zone' => '<string>',
    'recipients' => [
        '<string>'
    ],
    'message' => '<string>',
    'is_active' => true
  ]),
  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.arcuserp.com/v1/reporting-schedules/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\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.arcuserp.com/v1/reporting-schedules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/reporting-schedules/{id}")

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  \"name\": \"<string>\",\n  \"day_of_week\": 123,\n  \"day_of_month\": 123,\n  \"send_time\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"recipients\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"is_active\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "reporting_schedule",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "report_type": "<string>",
  "params": {},
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "<string>",
  "time_zone": "<string>",
  "recipients": [
    "<string>"
  ],
  "message": "<string>",
  "is_active": true,
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

string<uuid>

required

Reporting schedule UUID.

Body

application/json

name

string

cadence

enum<string>

Available options:

daily,

weekly,

monthly

day_of_week

integer | null

day_of_month

integer | null

send_time

string

time_zone

string

recipients

string[]

format

enum<string>

Available options:

csv,

pdf,

xlsx

message

string | null

is_active

boolean

Response

Updated reporting schedule.

A scheduled report delivery (cadence, recipients, format). Mirrors public.reporting_schedules.

string<uuid>

object

enum<string>

Available options:

reporting_schedule

entity_id

string<uuid>

name

string

report_type

string

params

object

cadence

enum<string>

Available options:

daily,

weekly,

monthly

day_of_week

integer | null

day_of_month

integer | null

send_time

string

time_zone

string

recipients

string[]

format

enum<string>

Available options:

csv,

pdf,

xlsx

message

string | null

is_active

boolean

last_run_at

string<date-time> | null

last_run_status

string | null

next_run_at

string<date-time> | null

created_at

string<date-time>

updated_at

string<date-time>

Overview

All Endpoints

Update a reporting schedule

Authorizations

Path Parameters

Body

Response