Skip to content

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

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.
Content-Typeyesapplication/json.

Request body

FieldTypeRequiredDescription
idintegeryesProject identifier.
namestringyesProject name.
labelstringyesProject label. The system normalizes it to lowercase and replaces spaces with _.
descriptionstringyesProject description.
has_alertingbooleannoAlerting flag.
masterindex_thresholdintegerstringnull
has_image_cachebooleannoImage cache flag.
has_engagement_updatesbooleannoEngagement refresh flag.
has_autosentimentbooleannoAuto-sentiment flag.
has_aisentimentbooleannoAI-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

FieldTypeDescription
idintegerProject identifier.
labelstringProject label.
namestringProject name.
descriptionstringnull
longDescriptionstringnull
keywordsstringnull
has_alertingbooleannull
has_autosentimentbooleannull
has_aisentimentbooleannull
has_image_cachebooleannull
has_engagement_updatesbooleannull
archivedbooleannull
tabsarray<object>Project tab definitions.

Notes

  • If label changes, project-specific resources are renamed as part of the update.

Doc rev.1.12.3 2026.05.08