Notification Preferences
numeric user id
GET /api/users/{user-id}/notification-preferences/alerts HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
[
{
"id": 1,
"method": "EMAIL",
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"delayMin": 1,
"type": "LOW_PRIORITY"
}
]
numeric user id
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"
}
the response
{
"id": 1,
"method": "EMAIL",
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"delayMin": 1,
"type": "LOW_PRIORITY"
}
numeric user id
entity ID
GET /api/users/{user-id}/notification-preferences/alerts/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
{
"id": 1,
"method": "EMAIL",
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"delayMin": 1,
"type": "LOW_PRIORITY"
}
numeric user id
entity ID
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"
}
the response
{
"id": 1,
"method": "EMAIL",
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"delayMin": 1,
"type": "LOW_PRIORITY"
}
numeric user id
entity ID
DELETE /api/users/{user-id}/notification-preferences/alerts/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
if deletion was successful
No content
numeric user id
GET /api/users/{user-id}/notification-preferences/duties HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
[
{
"id": 1,
"beforeMin": 0,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ON_CALL"
}
]
numeric user id
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"
}
the response
{
"id": 1,
"beforeMin": 0,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ON_CALL"
}
numeric user id
entity ID
GET /api/users/{user-id}/notification-preferences/duties/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
{
"id": 1,
"beforeMin": 0,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ON_CALL"
}
numeric user id
entity ID
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"
}
the response
{
"id": 1,
"beforeMin": 0,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ON_CALL"
}
numeric user id
entity ID
DELETE /api/users/{user-id}/notification-preferences/duties/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
if deletion was successful
No content
numeric user id
GET /api/users/{user-id}/notification-preferences/updates HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
[
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ALERT_ACCEPTED"
}
]
numeric user id
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"
}
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ALERT_ACCEPTED"
}
numeric user id
entity ID
GET /api/users/{user-id}/notification-preferences/updates/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ALERT_ACCEPTED"
}
numeric user id
entity ID
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"
}
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL",
"type": "ALERT_ACCEPTED"
}
numeric user id
entity ID
DELETE /api/users/{user-id}/notification-preferences/updates/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
if deletion was successful
No content
numeric user id
GET /api/users/{user-id}/notification-preferences/subscriptions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
[
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL"
}
]
numeric user id
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"
}
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL"
}
numeric user id
entity ID
GET /api/users/{user-id}/notification-preferences/subscriptions/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL"
}
numeric user id
entity ID
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"
}
the response
{
"id": 1,
"contact": {
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
},
"method": "EMAIL"
}
numeric user id
entity ID
DELETE /api/users/{user-id}/notification-preferences/subscriptions/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
if deletion was successful
No content
Was this helpful?