FishOutFishOut

Turn a built-in label on or off

PATCH/orgs/{organizationId}/projects/{projectId}/builtin-labels/{labelId}

Turn a built-in label on or off within the selected project. Off removes the label from future triage; labels already applied stay. Returns every label. Uses the app's permissions and entitlements.

Authorization

AuthorizationBearer <token>

Scoped FishOut API key. Never send credentials in query parameters.

In: header

Path Parameters

organizationId*string
Length1 <= length
projectId*string
Length1 <= length
labelId*string

Value in

  • "asking-for-recommendations"
  • "comparison"
  • "has-a-problem"
  • "question"
  • "complaint"
  • "praise"
  • "announcement"
  • "promotion"
  • "discussion"

Header Parameters

Idempotency-Key*string

Reuse for retries of the same action for 24 hours. A changed body returns 409.

Length8 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/orgs/string/projects/string/builtin-labels/asking-for-recommendations" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{  "data": [    {      "id": "string",      "projectId": "string",      "name": "string",      "description": "string",      "exclude": "string",      "examples": [        "string"      ],      "builtin": true,      "enabled": true,      "property1": "string",      "property2": "string"    }  ],  "meta": {    "requestId": "string",    "replayed": true  }}

Update a project label PATCH

Update a project label within the selected project. Only project labels (`lbl_` ids) can be edited; switch built-ins with set_builtin_label_enabled. Uses the app's permissions and entitlements.

Teach a correction on a mention POST

Teach a correction on a mention within the selected project. Kinds: not_relevant archives the mention; relevant lifts it out of Filtered; add_label/remove_label take a label id in value; set_sentiment takes a sentiment. The mention changes immediately and recent corrections are sent to future triage as examples. Uses the app's permissions and entitlements.