API Reference

Update an automation

patch
https://services.fountain.com/api/serviceintegrations/automations/

Update selected fields on one automation. Fields omitted from the request remain unchanged.

An automation defines the event and actions for an automated workflow. Automation events record what happened when those rules ran.

Path Params
uuid
required

automation unique identifier

Body Params
string
required
uuid
string
enum

custom marks an automation a talent-agent install creates. productBasedEvent marks an automation a Fountain product event triggers.

string
boolean
Defaults to true
string
string
string
event
object
number
string
Defaults to 0.1.0
string
enum
Allowed:
boolean
Defaults to false
string
enum

Automation category. "hire_system_automation" for Hire-seeded automations, "standard" for user-created.

Allowed:
uuid | null

Optional reference to an AutomationGroup. Unset means the automation is ungrouped.

string | null
enum

Why a system write paused this automation: agent_disabled when its custom agent was turned off, agent_unshared when its run-as person lost access to the agent. A save ignores a sent value, and activating the automation clears it.

Allowed:
Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?