Skip to main content
PUT
/
organizations
/
{orgId}
/
notifications
/
configurations
/
{id}
Update Notification
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/notifications/configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Commitment has under 10% remaining",
  "description": "Commitment amount fell below 10%",
  "code": "commitment_under_10_percent",
  "eventName": "configuration.commitment.updated",
  "version": 123,
  "active": true,
  "alwaysFireEvent": false,
  "calculation": "(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))"
}
'
{
  "id": "<string>",
  "name": "Commitment has under 10% remaining",
  "description": "Commitment amount fell below 10%",
  "code": "commitment_under_10_percent",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "active": true,
  "alwaysFireEvent": false,
  "eventName": "configuration.commitment.updated",
  "calculation": "(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

​
id
string
required

The unique identifier (UUID) of the Notification to update.

Body

application/json

Request containing a Notification entity.

​
name
string
required

The name of the Notification.

Minimum string length: 1
Example:

"Commitment has under 10% remaining"

​
description
string
required

The description for the Notification providing a brief overview of its purpose and functionality.

Minimum string length: 1
Example:

"Commitment amount fell below 10%"

​
code
string
required

The short code for the Notification.

Minimum string length: 1
Example:

"commitment_under_10_percent"

​
eventName
string
required

The name of the Event type that the Notification is based on. When an Event of this type occurs and any calculation built into the Notification evaluates to True, the Notification is triggered.

Note: If the Notification is set to always fire, then the Notification will always be sent when the Event of the type it is based on occurs, and without any other conditions defined by a calculation having to be met.

Minimum string length: 1
Example:

"configuration.commitment.updated"

​
version
integer<int64>

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
​
active
boolean

Boolean flag that sets the Notification as active or inactive. Only active Notifications are sent when triggered by the Event they are based on:

  • TRUE - set Notification as active.
  • FALSE - set Notification as inactive.
Example:

true

​
alwaysFireEvent
boolean

A Boolean flag indicating whether the Notification is always triggered, regardless of other conditions and omitting reference to any calculation. This means the Notification will be triggered simply by the Event it is based on occurring and with no further conditions having to be met.

  • TRUE - the Notification is always triggered and omits any reference to the calculation to check for other conditions being true before triggering the Notification.
  • FALSE - the Notification is only triggered when the Event it is based on occurs and any calculation is checked and all conditions defined by the calculation are met.
Example:

false

​
calculation
string

A logical expression that that is evaluated to a Boolean. If it evaluates as True, a Notification for the Event is created and sent to the configured destination. Calculations can reference numeric, string, and boolean Event fields.

See Creating Calculations in the m3ter documentation for more information.

Example:

"(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))"

Response

Returns the updated Notification

Response containing a Notification entity.

​
id
string
required

The UUID of the entity.

​
name
string
required

The name of the Notification.

Minimum string length: 1
Example:

"Commitment has under 10% remaining"

​
description
string
required

The description for the Notification providing a brief overview of its purpose and functionality.

Minimum string length: 1
Example:

"Commitment amount fell below 10%"

​
code
string
required

The short code for the Notification.

Minimum string length: 1
Example:

"commitment_under_10_percent"

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
dtCreated
string<date-time>

The DateTime when this item was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when this item was last modified (in ISO-8601 format).

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.

​
active
boolean

A Boolean flag indicating whether or not the Notification is active.

  • TRUE - active Notification.
  • FALSE - inactive Notification.
Example:

true

​
alwaysFireEvent
boolean

A Boolean flag indicating whether the Notification is always triggered, regardless of other conditions and omitting reference to any calculation. This means the Notification will be triggered simply by the Event it is based on occurring and with no further conditions having to be met.

  • TRUE - the Notification is always triggered and omits any reference to the calculation to check for other conditions being true before triggering the Notification.
  • FALSE - the Notification is only triggered when the Event it is based on occurs and any calculation is checked and all conditions defined by the calculation are met.
Example:

false

​
eventName
string

The name of the Event that the Notification is based on. When this Event occurs and the calculation evaluates to True, the Notification is triggered.

Note: If the Notification is set to always fire, then the Notification will always be sent when the Event it is based on occurs, and without any other conditions defined by a calculation having to be met.

Example:

"configuration.commitment.updated"

​
calculation
string

A logical expression that that is evaluated to a Boolean. If it evaluates as True, a Notification for the Event is created and sent to the configured destination. Calculations can reference numeric, string, and boolean Event fields.

See Creating Calculations in the m3ter documentation for more information.

Example:

"(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))"