Notifications Settings

Use to manage notifications settings.

Get notifications settings

get

Returns all notifications-related settings for the tenant.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

Aggregated response containing all notifications settings configured for the tenant

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/notifications/settings

HTTPcURLJavaScriptPython

GET /api/v1/notifications/settings HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "adminMessage": {
    "value": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "msg": "System maintenance scheduled for this weekend",
      "createdAt": 1706886400000,
      "enableDismiss": true
    },
    "displayName": "Admin message",
    "description": "Write a message that will be displayed to all users"
  }
}

Get notifications setting by key

get

Returns a single notifications setting identified by the path key.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

keystring · enumRequired

Identifier of the notifications setting to retrieve or update.

Possible values:

Responses

200

Executed successfully.

application/json

objectOptional

Dynamic settings response that varies by setting key

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/notifications/settings/{key}

HTTPcURLJavaScriptPython

GET /api/v1/notifications/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "msg": "System maintenance scheduled",
    "createdAt": 1706886400000,
    "enableDismiss": true
  },
  "displayName": "Admin message",
  "description": "Write a message that will be displayed to all users"
}

Update notifications setting by key

put

Updates a single notifications setting identified by the path key.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

keystring · enumRequired

Identifier of the notifications setting to retrieve or update.

Possible values:

Body

application/json

Responses

200

Setting successfully updated

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/api/v1/notifications/settings/{key}

HTTPcURLJavaScriptPython

PUT /api/v1/notifications/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "msg": "System maintenance scheduled for this weekend",
  "enableDismiss": true
}

No content