---
title: "act: sync rule"
description: "the installed connector, the offer, the fields of section 2.8 to the rule; for a preview, what it would read and push"
section: reference
address: /reference/act/sync_rule
contract: 0476e35e6e275db5
---
# act: sync rule
the installed connector, the offer, the fields of section 2.8 to the rule; for a preview, what it would read and push
[figure: The caller sends SyncRuleInput to /v1/act/sync_rule. The platform returns a card whose body is SyncPreview.]
POST/v1/act/sync_rule
Write, preview and arm a sync rule. The call needs the brand rung under a token with the act grant, and it is served by the platform.
The route takes [SyncRuleInput](/concepts/syncruleinput) and returns a card whose body is [SyncPreview](/concepts/syncpreview).
## Request body
The request body is [SyncRuleInput](/concepts/syncruleinput).
| field | type | required | note |
|---|---|---|---|
| `rule` | [SyncRule](/concepts/syncrule) | yes | |
| `flow` | `one of write \| preview \| arm \| disarm` | yes | |
## Response
The route returns a card whose body is [SyncPreview](/concepts/syncpreview). Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.
## Headers
| header | required | meaning |
|---|---|---|
| `Scale-Scope` | yes | the scope the call runs in: tenant/, then /brand/, then /strategy/ |
| `Scale-As-True-On` | no | the date the facts must have been true on; defaults to now |
| `Scale-As-Known-On` | no | the date the facts must have been known on; defaults to now |
| `Scale-Key` | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the brand rung and a token with the act grant. The platform serves this route.
## Example
The example sends the smallest body that SyncRuleInput allows. The build validates it against the schema of SyncRuleInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/act/sync_rule \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "rule": { "installed_connector": "…", "offer": { "reading": "…", "action": "…", "identity_link": "…", "directions": [] }, "direction": "pull", "push_mappings": [], "conflict": "the source wins", "grant": "…", "state": { "ready": false, "since": "…" } }, "flow": "write" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.act.sync_rule({
"rule": {
"installed_connector": "…",
"offer": {
"reading": "…",
"action": "…",
"identity_link": "…",
"directions": []
},
"direction": "pull",
"push_mappings": [],
"conflict": "the source wins",
"grant": "…",
"state": {
"ready": false,
"since": "…"
}
},
"flow": "write"
});
// answer.body is a SyncPreview. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/sync_rule",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"rule": {
"installed_connector": "…",
"offer": {
"reading": "…",
"action": "…",
"identity_link": "…",
"directions": []
},
"direction": "pull",
"push_mappings": [],
"conflict": "the source wins",
"grant": "…",
"state": {
"ready": false,
"since": "…"
}
},
"flow": "write"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/sync_rule")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&SyncRuleInput { /* the fields of the page */ }).send().await?.json().await?;
```