Validate and publish a draft rule version (draft → active)

Requires ADMIN. Validates condition tree, effects, and cross-tenant poolIds.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

required

string

Responses

200

Published (active) version.

application/json

object

version

object

string

projectId

string

campaignId

string

version

integer

conditionJson

string

effectsJson

string

rulesHash

string

status

string

cooldownSeconds

integer

createdAt

string

publishedAt

string | null

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

404

Resource not found (or cross-tenant — same 404).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

409

Not draft (error=invalid_state) or active-version conflict (error=active_version_conflict).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Invalid condition JSON/tree, effects, or cross-tenant pool (error in [invalid_condition_json, invalid_condition_tree, invalid_effects_json, invalid_effects, cross_tenant_pool]).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/projects/{projectId}/incentive-rules/{id}/publish

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/incentive-rules/%3Cstring%3E/publish \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/incentive-rules/%3Cstring%3E/publish';
2
const options = {method: 'POST', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/incentive-rules/%3Cstring%3E/publish"
4

5
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
6

7
response = requests.post(url, headers=headers)
8

9
print(response.json())

1
import httpx
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/incentive-rules/%3Cstring%3E/publish"
4

5
cookies = {"trackly_session": "<YOUR_API_KEY>"}
6

7
response = httpx.post(url, cookies=cookies)
8

9
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "net/http"
6
  "io"
7
)
8

9
func main() {
10

11
  url := "https://retidal.com/api/projects/%3Cstring%3E/incentive-rules/%3Cstring%3E/publish"
12

13
  req, _ := http.NewRequest("POST", url, nil)
14

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

17
  res, _ := http.DefaultClient.Do(req)
18

19
  defer res.Body.Close()
20
  body, _ := io.ReadAll(res.Body)
21

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200Published (active) version.

1
{
2
  "version": {
3
    "status": "draft"
4
  }
5
}

Validate and publish a draft rule version (draft → active)

Authorizations

Parameters

Path Parameters

Responses

200

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated