Skip to main content
POST
Propose automation rule edits
First step of the propose → confirm flow for changing a rule. Only a rule that is off can be edited; an active rule answers 409 rule_active. The event can’t change: sending a different event_name answers 422 event_change_not_allowed, so propose a new rule on the other event instead. See Propose an automation rule for the full walkthrough, the list of warnings, and who turns rules on.

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

automationRuleId
integer
required

The id returned when the automation rule was listed.

Example:

9

Body

application/json
automation_rule
object
required

Only the fields to change; what is not sent stays as it is. At least one field is required. conditions and actions replace the whole list.

Response

The proposal. Nothing was written.

proposal_token
string
required

Single-use token for the matching confirm call. It is tied to this account and to the user who proposed, and it stops working at expires_at.

Example:

"eyJfcmFpbHMiOnsiZGF0YSI6eyJqdGkiOiI0YjEw..."

expires_at
string<date-time>
required

When the token stops working. Read it from here instead of assuming a fixed lifetime.

Example:

"2026-11-12T14:20:00Z"

kind
enum<string>
required
Available options:
edits
Example:

"edits"

automation_rule_id
integer
required
Example:

31

diff
object[]
required

One entry per field that changes. Fields sent with their current value are left out.

warnings
object[]
required

Risks detected in the proposal. Empty when nothing was found.