Create a draft incentive rule version

Requires ADMIN. conditionJson validated as a condition tree at publish time.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

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

Request Body^required

application/json

object

campaignId

required

string

>= 1 characters

conditionJson

required

Condition tree (all/any/not + fact conditions); validated at publish.

effectsJson

required

Array<object>

object

type

required

string

props

cooldownSeconds

integer

notes

string

Responses

201

Created draft 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

Campaign not found in project (error=campaign_not_found).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

409

Duplicate rules content hash (error=duplicate_rules).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

422

Zod validation failed (error=‘参数校验失败’ with issues[]).

application/json

object

error

required

string

issues

Array<object>

object

path

string

message

string

details

Array<object>

object

key

additional properties

any

key

additional properties

any

Example

1
{
2
  "error": "参数校验失败"
3
}

POST

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

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/incentive-rules \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "campaignId": "<string>",
7
  "conditionJson": "<string>",
8
  "effectsJson": [
9
    {
10
      "type": "<string>",
11
      "props": "<string>"
12
    }
13
  ],
14
  "cooldownSeconds": 0,
15
  "notes": "<string>"
16
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/incentive-rules';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"campaignId":"<string>","conditionJson":"<string>","effectsJson":[{"type":"<string>","props":"<string>"}],"cooldownSeconds":0,"notes":"<string>"}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

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

5
payload = {
6
    "campaignId": "<string>",
7
    "conditionJson": "<string>",
8
    "effectsJson": [
9
        {
10
            "type": "<string>",
11
            "props": "<string>"
12
        }
13
    ],
14
    "cooldownSeconds": 0,
15
    "notes": "<string>"
16
}
17
headers = {
18
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
19
    "Content-Type": "application/json"
20
}
21

22
response = requests.post(url, json=payload, headers=headers)
23

24
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"campaignId\": \"<string>\",\n  \"conditionJson\": \"<string>\",\n  \"effectsJson\": [\n    {\n      \"type\": \"<string>\",\n      \"props\": \"<string>\"\n    }\n  ],\n  \"cooldownSeconds\": 0,\n  \"notes\": \"<string>\"\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

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

10
func main() {
11

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

14
  payload := strings.NewReader("{\n  \"campaignId\": \"<string>\",\n  \"conditionJson\": \"<string>\",\n  \"effectsJson\": [\n    {\n      \"type\": \"<string>\",\n      \"props\": \"<string>\"\n    }\n  ],\n  \"cooldownSeconds\": 0,\n  \"notes\": \"<string>\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created draft version.

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

Create a draft incentive rule version

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated