Moogsoft Docs

updateCustomInfo

A MoogDb v2 method that updates the custom info for an alert or a Situation.

Back to MoogDb V2 API Method Reference.

Request arguments

Method updateCustomInfo takes the following request arguments:

Name

Type

Required

Description

toUpdate

CEvent

Yes

A CEvent representing the alert or Situation you want to update.

toMerge

JSON Object

Yes

Custom info to add to or replace the existing custom info field.

merge

Boolean

No

For an alert you can also use the following arguments:

Name

Type

Required

Description

alertId

Number

No

ID of the alert you want to add custom info to.

path

String

No

Dot-notation path to the custom_info key where the info is stored. Updates the existing value if the key already exists; creates the full path if the key does not exist.

param

Value

No

Value to put at the specified key.

Response

Method updateCustomInfo returns the following response:

Examples

The following examples demonstrate typical use of method updateCustomInfo:

Response example