Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

The automation settings to change. A setting left out keeps its value.

max_steps
integer

The most steps an automation may have: 1 to 50, 20 by default.

Required range: 1 <= x <= 50
step_retries
integer

How often a step that failed for a temporary reason is tried again: 0 to 10, 3 by default.

Required range: 0 <= x <= 10
retry_delays
integer[]

Minutes before each retry, 1 to 1440 each, [1, 5, 15] by default; the last repeats.

Required array length: 1 - 10 elements
Required range: 1 <= x <= 1440
pause_after_failures
integer

Failed runs in a row that turn an automation off: 1 to 100, 5 by default.

Required range: 1 <= x <= 100
run_retention_days
integer

Days run history is kept: 1 to 3650, 90 by default, never past the plan's audit retention.

Required range: 1 <= x <= 3650
usage_alerts
integer[]

Percentages of the month's runs, 1 to 100 each, that email owners and automation managers: [80, 100] by default, none to turn the emails off.

Maximum array length: 5
Required range: 1 <= x <= 100
external_email
boolean

Whether email steps may write to addresses outside the organization: on by default on the commercial plane, off on the federal plane.

emails_per_recipient_per_hour
integer

The most emails automations send one address in an hour: 1 to 1000, 20 by default.

Required range: 1 <= x <= 1000
default_timezone
string

The time zone a new schedule starts in, such as America/Chicago: UTC by default.

max_chain_depth
integer

The most automation runs a chain of events may hold: 1 to 10, 3 by default.

Required range: 1 <= x <= 10
runs_per_minute
integer

The most runs one automation starts in a minute: 1 to 1000, 60 by default.

Required range: 1 <= x <= 1000
approval_timeout_hours
integer

How many hours an approval waits for an answer before it times out, unless its step says otherwise: 1 to 720, 72 by default.

Required range: 1 <= x <= 720
allow_self_approval
boolean

Whether the person who started a run, or whose action caused its trigger, may answer its approvals: off by default.

code_cpu_ms
integer

A code step's CPU time per run, in milliseconds: 10 to 1000, 250 by default.

Required range: 10 <= x <= 1000
code_wall_ms
integer

A code step's wall-clock time per run, in milliseconds: 100 to 5000, 1000 by default.

Required range: 100 <= x <= 5000
code_memory_mb
integer

A code step's memory per run, in megabytes: 16 to 128, 32 by default.

Required range: 16 <= x <= 128
code_output_kb
integer

A code step's output per run, in kilobytes: 1 to 1024, 64 by default.

Required range: 1 <= x <= 1024

Response

AutomationSettingsResource

data
AutomationSettingsResource · object
required