Skip to main content
POST
Propose a new rule order
First step of the propose → confirm flow for reordering. Send every rule of the event, and leave the ClaudIA integration rules where they are. 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

Body

application/json
event_name
string
required

The event whose rules are reordered.

Example:

"conversation_created"

rule_ids
integer[]
required

Every rule of the event, each exactly once, in the new execution order. Inactive rules and rules managed by the ClaudIA integration count too; the latter must stay at their current position.

Example:

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:
reorder
Example:

"reorder"

event_name
string
required
Example:

"conversation_created"

before
object[]
required

The event's rules in the current execution order.

after
object[]
required

The same rules in the proposed order, each with the order_id it will have after the confirm.

warnings
object[]
required

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