Create loyalty tier

Requires ADMIN. programId must belong to the project.

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

programId

required

string

>= 1 characters

name

required

string

>= 1 characters <= 80 characters

minValueScore

number

sortOrder

integer

configJson

object

key

additional properties

any

Responses

201

Created tier.

application/json

object

tier

object

string

projectId

string

programId

string

programName

string

name

string

minValueScore

number

sortOrder

integer

userCount

integer

configJson

string

key

additional properties

any

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

Referenced loyalty program not found (error=‘loyalty_program not_found’).

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}/loyalty/tiers

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/loyalty/tiers \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "programId": "<string>",
7
  "name": "<string>",
8
  "minValueScore": 0,
9
  "sortOrder": 0,
10
  "configJson": {}
11
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/loyalty/tiers';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"programId":"<string>","name":"<string>","minValueScore":0,"sortOrder":0,"configJson":{}}'
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/loyalty/tiers"
4

5
payload = {
6
    "programId": "<string>",
7
    "name": "<string>",
8
    "minValueScore": 0,
9
    "sortOrder": 0,
10
    "configJson": {}
11
}
12
headers = {
13
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
14
    "Content-Type": "application/json"
15
}
16

17
response = requests.post(url, json=payload, headers=headers)
18

19
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/loyalty/tiers"
5

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

8
payload = json.loads("{\n  \"programId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"minValueScore\": 0,\n  \"sortOrder\": 0,\n  \"configJson\": {}\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/loyalty/tiers"
13

14
  payload := strings.NewReader("{\n  \"programId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"minValueScore\": 0,\n  \"sortOrder\": 0,\n  \"configJson\": {}\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 tier.

1
{
2
  "tier": {
3
    "id": "example",
4
    "projectId": "example",
5
    "programId": "example",
6
    "programName": "example",
7
    "name": "example",
8
    "minValueScore": 1,
9
    "sortOrder": 1,
10
    "userCount": 1,
11
    "configJson": "example"
12
  }
13
}

Create loyalty tier

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

422

Example

Request Body^required

Example^generated

Example^generated

Example^generated