Appearance
project/edit
Updates project metadata and feature flags.
Method and path
POST /project/edit
Authentication
Authentication is required. See Authentication.
Permissions
Accessible to tier 1 and 2 users.
Request headers
| Header | Required | Description |
|---|---|---|
X-Api-Key or X_API_KEY | yes | API key. |
Content-Type | yes | application/json. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | Project identifier. |
name | string | yes | Project name. |
label | string | yes | Project label. The system normalizes it to lowercase and replaces spaces with _. |
description | string | yes | Project description. |
has_alerting | boolean | no | Alerting flag. |
masterindex_threshold | integer | string | null |
has_image_cache | boolean | no | Image cache flag. |
has_engagement_updates | boolean | no | Engagement refresh flag. |
has_autosentiment | boolean | no | Auto-sentiment flag. |
has_aisentiment | boolean | no | AI-sentiment flag. |
Example request
bash
curl -X POST "$SIGNAL_API_BASE_URL/project/edit" \
-H "X-Api-Key: $SIGNAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": 123,
"name": "Example Project",
"label": "example_project",
"description": "Updated description"
}'json
{
"id": 123,
"name": "Example Project",
"label": "example_project",
"description": "Updated description",
"has_alerting": true,
"masterindex_threshold": 10,
"has_image_cache": false,
"has_engagement_updates": true,
"has_autosentiment": false,
"has_aisentiment": true
}Example response
json
{
"id": 123,
"label": "example_project",
"name": "Example Project",
"description": "Updated description",
"longDescription": null,
"keywords": null,
"has_alerting": true,
"has_autosentiment": false,
"has_aisentiment": true,
"has_image_cache": false,
"has_engagement_updates": true,
"archived": false,
"tabs": []
}Response fields
| Field | Type | Description |
|---|---|---|
id | integer | Project identifier. |
label | string | Project label. |
name | string | Project name. |
description | string | null |
longDescription | string | null |
keywords | string | null |
has_alerting | boolean | null |
has_autosentiment | boolean | null |
has_aisentiment | boolean | null |
has_image_cache | boolean | null |
has_engagement_updates | boolean | null |
archived | boolean | null |
tabs | array<object> | Project tab definitions. |
Notes
- If
labelchanges, project-specific resources are renamed as part of the update.