Update an Issue Alert Rule

Options

Organization Id or Slug

The ID or slug of the organization the resource belongs to.

Project Id or Slug

The ID or slug of the project the resource belongs to.

Rule Id

The ID of the rule you'd like to query.

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "actionMatch", "actions", "conditions", "frequency", "name" ],
  "type" : "object",
  "properties" : {
    "name" : {
      "maxLength" : 256,
      "type" : "string",
      "description" : "The name for the rule."
    },
    "actionMatch" : {
      "type" : "string",
      "description" : "A string determining which of the conditions need to be true before any filters are evaluated.\n\n* `all` - All conditions must evaluate to true.\n* `any` - At least one of the conditions must evaluate to true.\n* `none` - All conditions must evaluate to false.",
      "enum" : [ "all", "any", "none" ]
    },
    "conditions" : {
      "type" : "array",
      "description" : "A list of triggers that determine when the rule fires. See [Create an Issue Alert Rule](/api/alerts/create-an-issue-alert-rule-for-a-project) for valid conditions.",
      "items" : {
        "type" : "object",
        "additionalProperties" : { }
      }
    },
    "actions" : {
      "type" : "array",
      "description" : "A list of actions that take place when all required conditions and filters for the rule are met. See [Create an Issue Alert Rule](/api/alerts/create-an-issue-alert-rule-for-a-project) for valid actions.",
      "items" : {
        "type" : "object",
        "additionalProperties" : { }
      }
    },
    "frequency" : {
      "maximum" : 43200,
      "minimum" : 5,
      "type" : "integer",
      "description" : "How often to perform the actions once for an issue, in minutes. The valid range is `5` to `43200`."
    },
    "environment" : {
      "type" : "string",
      "description" : "The name of the environment to filter by.",
      "nullable" : true
    },
    "filterMatch" : {
      "type" : "string",
      "description" : "A string determining which filters need to be true before any actions take place.\n\n* `all` - All filters must evaluate to true.\n* `any` - At least one of the filters must evaluate to true.\n* `none` - All filters must evaluate to false.",
      "enum" : [ "all", "any", "none" ]
    },
    "filters" : {
      "type" : "array",
      "description" : "A list of filters that determine if a rule fires after the necessary conditions have been met. See [Create an Issue Alert Rule](/api/alerts/create-an-issue-alert-rule-for-a-project) for valid filters.",
      "items" : {
        "type" : "object",
        "additionalProperties" : { }
      }
    },
    "owner" : {
      "type" : "string",
      "description" : "The ID of the team or user that owns the rule.",
      "nullable" : true
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Owner:
• Created By:
• Environment:
• Last Triggered:
• Snooze Created By:
• Snooze for Everyone:
• Id:
• Conditions:
• Filters:
• Actions:
• Action Match:
• Filter Match:
• Frequency:
• Name:
• Date Created:
• Projects:
• Status:
• Snooze:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers