Sign in
Notifications

Update a notification rule

Update notification rule.

put/api/v1/notification/rules/{ruleId}

Path parameters

ruleIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

OR
OR
OR

Example request

{
  "channels": [
    "01G65Z755AFWAKHE12NY0CQ9FH"
  ],
  "disabled": true,
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "name": "Balance threshold reached",
  "thresholds": [
    {
      "value": 100
    }
  ]
}

Response

The request has succeeded.

OR
OR
OR

Example response

{
  "annotations": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "channels": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ],
  "createdAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "disabled": true,
  "features": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "key": "gpt4_tokens"
    }
  ],
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "name": "Balance threshold reached",
  "thresholds": [
    {
      "value": 100
    }
  ],
  "updatedAt": "2024-01-01T01:01:01.001Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.