Skip to main content
PATCH
/
api
/
automations
/
{id}
/
preference
Update user automation preference (enable/disable)
curl --request PATCH \
  --url https://your-instance.example.com/api/automations/{id}/preference \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'
{
  "success": true,
  "message": "Automation enabled successfully",
  "data": {
    "automationId": "64d2f9c5e8a1d4e001a0b1c2",
    "enabled": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
enabled
boolean
required

Per-user on/off flag for the automation; stored on the User document (not the Automation itself).

Response

Automation preference updated

Returned after a user toggles per-user enabled state for an automation. The flag is stored on the User document, not the Automation.

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
message
string