Skip to main content
PUT
Update a goal

Authorizations

Authorization
string
header
required

API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 100
description
string
instructions
string
metrics
object
scenario_id
string

ID of the scenario this goal is directly linked to

active
boolean

Whether this goal is active for the scenario

scenarios
string[]

Array of scenario IDs to associate with this goal (legacy support)

Response

Goal updated successfully