Skip to main content
PATCH
Update a trigger

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.

Path Parameters

trigger_id
string<uuid>
required

Body

application/json

Fields patchable on any trigger type.

name
string | null

Trigger name

event_type
string | null
action
string | null
service_config
Service Config · object | null
frequency
enum<string> | null

How often to run

Available options:
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
CRON
time_of_day
string | null

HH:MM, for DAILY, WEEKLY and MONTHLY

days_of_month
string | null
days_of_week
string | null

Comma-separated day names, e.g. MONDAY,THURSDAY, for WEEKLY

minutes_of_hour
string | null
cron_expression
string | null

Cron expression, for CRON

cron_timezone
string | null
agent_input
Agent Input · object | null

What the agent receives each run, e.g. {"type": "text", "text": "..."}

Response

Successful response

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
agent_id
string<uuid>

The workspace agent to run when the trigger is activated.

name
string

Human-readable label identifying the trigger within its workspace.

Maximum string length: 255
workspace_id
string<uuid>
creator_id
string<uuid> | null

The actor (a user or an account API key) that created this trigger. Null for legacy rows created before creator attribution was recorded.

deactivated_at
string<date-time> | null

If set, indicates when the trigger has been deactivated.

type
enum<string>

Trigger type discriminator

Available options:
api
agent
object
workspace_agent
object