ANangelcam
rts_notification_rules

Update notification rule

Update notification rule

put/rts/notifications/rules/{rule_id}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesnotifications_rules_manage
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

rule_idinteger required

Notification rule ID

Request body

notification_methodinteger required

notification method ID

message_type'my_incident' | 'shared_incident' | 'arming' | 'trigger_action' | 'open_incident_verification' | 'verify_incident' | 'close_incident' | 'arrow_status_online' | 'arrow_status_offline' | 'camera_status_online' | 'camera_status_offline' required

message type to send notification for

allowed_camerasinteger[]
allowed_arrow_clientsstring[]

Example request

{
  "id": 85,
  "notification_method": 254,
  "message_type": "camera_status_online",
  "allowed_cameras": [
    1,
    2,
    3
  ]
}

Response

OK

idinteger required

notification rule ID

notification_methodinteger required

notification method ID

message_type'my_incident' | 'shared_incident' | 'arming' | 'trigger_action' | 'open_incident_verification' | 'verify_incident' | 'close_incident' | 'arrow_status_online' | 'arrow_status_offline' | 'camera_status_online' | 'camera_status_offline' required

message type to send notification for

allowed_camerasinteger[]
allowed_arrow_clientsstring[]

Example response

{
  "id": 85,
  "notification_method": 254,
  "message_type": "camera_status_online",
  "allowed_cameras": [
    1,
    2,
    3
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.