Update a project's name/description/domain (project ADMIN)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Request Body^required

application/json

object

name

string

description

string | null

domain

string | null

Example^generated

1
{
2
  "name": "example",
3
  "description": "example",
4
  "domain": "example"
5
}

Responses

200

Updated

application/json

object

project

Any of:

object
null

object

string

name

string

slug

string

description

string | null

domain

string | null

isActive

boolean

createdAt

string

updatedAt

string

_count

object

members

integer

400

Missing projectId / invalid JSON

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

401

Not authorized

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

403

Needs project ADMIN

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

PUT

/api/projects/{projectId}

1
curl --request PUT \
2
  --url https://retidal.com/api/projects/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "description": "<string>",
8
  "domain": "<string>"
9
}'

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

5
payload = {
6
    "name": "<string>",
7
    "description": "<string>",
8
    "domain": "<string>"
9
}
10
headers = {
11
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
12
    "Content-Type": "application/json"
13
}
14

15
response = requests.put(url, json=payload, headers=headers)
16

17
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"domain\": \"<string>\"\n}")
9

10
response = httpx.put(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"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"domain\": \"<string>\"\n}")
15

16
  req, _ := http.NewRequest("PUT", 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
}

200Updated

1
{
2
  "project": {
3
    "id": "example",
4
    "name": "example",
5
    "slug": "example",
6
    "description": "example",
7
    "domain": "example",
8
    "isActive": true,
9
    "createdAt": "example",
10
    "updatedAt": "example",
11
    "_count": {
12
      "members": 1
13
    }
14
  }
15
}

Update a project's name/description/domain (project ADMIN)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated