LoginStart for Free

Notification Preferences

Get alert notification preferences of a user

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/alerts HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

[
  {
    "id": 1,
    "method": "EMAIL",
    "contact": {
      "id": 1,
      "regionCode": "text",
      "target": "text",
      "primary": true,
      "status": "OK"
    },
    "delayMin": 1,
    "type": "LOW_PRIORITY"
  }
]

Create an alert notification preference

post
Authorizations
Path parameters
user-idstringRequired

numeric user id

Body
methodstring · enumOptionalPossible values:
contactone ofOptional
or
delayMinintegerOptional
typestring · enumOptionalPossible values:
Responses
201
the response
application/json
post
POST /api/users/{user-id}/notification-preferences/alerts HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "method": "EMAIL",
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "delayMin": 1,
  "type": "LOW_PRIORITY"
}
201

the response

{
  "id": 1,
  "method": "EMAIL",
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "delayMin": 1,
  "type": "LOW_PRIORITY"
}

Get specific notification preferences alert

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/alerts/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

{
  "id": 1,
  "method": "EMAIL",
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "delayMin": 1,
  "type": "LOW_PRIORITY"
}

Update a user's alert notification preference

put
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
methodstring · enumOptionalPossible values:
contactone ofOptional
or
delayMinintegerOptional
typestring · enumOptionalPossible values:
Responses
200
the response
application/json
put
PUT /api/users/{user-id}/notification-preferences/alerts/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "method": "EMAIL",
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "delayMin": 1,
  "type": "LOW_PRIORITY"
}
200

the response

{
  "id": 1,
  "method": "EMAIL",
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "delayMin": 1,
  "type": "LOW_PRIORITY"
}

Delete the user's specified notification preferences alert

delete
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
204
if deletion was successful
delete
DELETE /api/users/{user-id}/notification-preferences/alerts/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content

Get duty notification preferences of a user

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/duties HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

[
  {
    "id": 1,
    "beforeMin": 0,
    "contact": {
      "id": 1,
      "regionCode": "text",
      "target": "text",
      "primary": true,
      "status": "OK"
    },
    "method": "EMAIL",
    "type": "ON_CALL"
  }
]

Create a duty notification preference

post
Authorizations
Path parameters
user-idstringRequired

numeric user id

Body
beforeMininteger · enumOptionalPossible values:
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
201
the response
application/json
post
POST /api/users/{user-id}/notification-preferences/duties HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "beforeMin": 0,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ON_CALL"
}
201

the response

{
  "id": 1,
  "beforeMin": 0,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ON_CALL"
}

Get specific notification preferences duty

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/duties/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

{
  "id": 1,
  "beforeMin": 0,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ON_CALL"
}

Update a user's duty notification preference

put
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
beforeMininteger · enumOptionalPossible values:
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
200
the response
application/json
put
PUT /api/users/{user-id}/notification-preferences/duties/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "beforeMin": 0,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ON_CALL"
}
200

the response

{
  "id": 1,
  "beforeMin": 0,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ON_CALL"
}

Delete the user's specified notification preferences duty

delete
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
204
if deletion was successful
delete
DELETE /api/users/{user-id}/notification-preferences/duties/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content

Get update notification preferences of a user

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/updates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

[
  {
    "id": 1,
    "contact": {
      "id": 1,
      "regionCode": "text",
      "target": "text",
      "primary": true,
      "status": "OK"
    },
    "method": "EMAIL",
    "type": "ALERT_ACCEPTED"
  }
]

Create an update notification preference

post
Authorizations
Path parameters
user-idstringRequired

numeric user id

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
201
the response
application/json
post
POST /api/users/{user-id}/notification-preferences/updates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ALERT_ACCEPTED"
}
201

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ALERT_ACCEPTED"
}

Get specific notification preferences update

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/updates/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ALERT_ACCEPTED"
}

Update a user's update notification preference

put
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
200
the response
application/json
put
PUT /api/users/{user-id}/notification-preferences/updates/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ALERT_ACCEPTED"
}
200

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL",
  "type": "ALERT_ACCEPTED"
}

Delete the user's specified notification preferences update

delete
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
204
if deletion was successful
delete
DELETE /api/users/{user-id}/notification-preferences/updates/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content

Get subscription notification preferences of a user

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

[
  {
    "id": 1,
    "contact": {
      "id": 1,
      "regionCode": "text",
      "target": "text",
      "primary": true,
      "status": "OK"
    },
    "method": "EMAIL"
  }
]

Create a subscription notification preference

post
Authorizations
Path parameters
user-idstringRequired

numeric user id

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
Responses
201
the response
application/json
post
POST /api/users/{user-id}/notification-preferences/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL"
}
201

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL"
}

Get specific notification preferences subscription

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200
the response
application/json
get
GET /api/users/{user-id}/notification-preferences/subscriptions/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL"
}

Update a user's subscription notification preference

put
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
Responses
200
the response
application/json
put
PUT /api/users/{user-id}/notification-preferences/subscriptions/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL"
}
200

the response

{
  "id": 1,
  "contact": {
    "id": 1,
    "regionCode": "text",
    "target": "text",
    "primary": true,
    "status": "OK"
  },
  "method": "EMAIL"
}

Delete the user's specified notification preferences subscription

delete
Authorizations
Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
204
if deletion was successful
delete
DELETE /api/users/{user-id}/notification-preferences/subscriptions/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content
PreviousAuthenticationNextEscalation Policies

Was this helpful?