COconnexcs
Alert

Update

Changed on

Update an existing Alert record by ID.

put/api/cp/alert/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

company_idinteger required

Company Id (references company.id)

titlestring

Title

areastring required

Area

operator'<' | '<=' | '=' | '>' | '>=' | 'always'

Operator

thresholdnumber

Threshold

reset_thresholdnumber

Reset Threshold

sample_periodinteger

Sample Period

recipientstring

Recipient

templatestring

Template

state'Paused' | 'Ready' | 'Fired' | 'Sent' | 'Simulate'

State

penaltyinteger

Penalty

reset_timeoutstring date-time

Reset Timeout

cronstring

Cron

sandbox_idinteger

Sandbox Id

last_ranstring date-time nullable

Last Ran

next_runstring date-time

Next Run

tagstring

Tag

notice_level'none' | 'warning' | 'error' required

Notice Level

table_changestring

Table Change

querystring

Query

Example request

{
  "id": 12345,
  "company_id": 1,
  "title": "Example Name",
  "area": "example_area",
  "operator": "<",
  "threshold": 99.99,
  "reset_threshold": 99.99,
  "sample_period": 123,
  "recipient": "example_recipient",
  "template": "example_template",
  "state": "Paused",
  "penalty": 123,
  "reset_timeout": "2025-01-17T10:30:00Z",
  "cron": "example_cron",
  "sandbox_id": 1,
  "last_ran": "2025-01-17T10:30:00Z",
  "next_run": "2025-01-17T10:30:00Z",
  "tag": "example_tag",
  "notice_level": "none",
  "table_change": "example_table_change",
  "query": "Sample query text content"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API