Account Health

Update account health insight

Changed on

Dismisses, snoozes, resolves or reopens one insight. A resolved insight reopens if the next check still finds it; a dismissed one stays hidden. Requires the sequences:write scope.

patch/account-health/insights/{insightId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/account-health/insights/{insightId}
  • Auth
    HTTP bearer

Path parameters

insightIdstring required

Request body

action'dismiss' | 'snooze' | 'resolve' | 'reopen' required
snoozeDaysinteger

Days to snooze, only with action snooze. Defaults to 7.

Response

Insight updated

successboolean

Example response

{
  "insight": {
    "title": "Nothing happens after \"trial_ended\"",
    "actions": [
      {
        "label": "Build this sequence",
        "path": "/campaign?action=new",
        "api": {
          "path": "/sequences/seq_123/disable"
        }
      }
    ]
  }
}

Changes

  • 8156dc12d8b4Revision changes
    • warning

      added the new review_subscribers enum value to the /// response property for the response status

    • warning

      added the new unengaged_signups enum value to the / response property for the response status

  • db3873ca3d4dRevision changes
    • info

      endpoint added