Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Notification rule steps

Update notification rule step

Updates a notification rule step with given id in the request.

patch/api/{cloudId}/v1/notification-rules/{ruleId}/steps/{id}

Path parameters

ruleIdstring required

Identifier of the notification rule.

idstring required

Identifier of the notification rule step which belongs to given notification rule.

Request body

sendAfterinteger

Time period when notification will be sent after in minutes.

enabledboolean

Specifies whether given step will be enabled or not when it is created.

Example request

{
  "contact": {
    "method": "email",
    "to": "johnsmith@atlassian.com"
  },
  "sendAfter": 5
}

Response

Returned if the request is successful.

idstring

Identifier of the notification rule step which belongs to given notification rule.

sendAfterinteger

Time period when notification will be sent after in minutes.

enabledboolean

Specifies whether given step will be enabled or not when it is created.

Example response

{
  "id": "dbf70781-d6d8-4924-b90d-6a0c77833748",
  "sendAfter": 5,
  "contact": {
    "method": "email",
    "to": "johnsmith@atlassian.com"
  }
}