Update notification

Update an existing notification

PUT

https://api.channelautomation.com/api/notifications/{workspaceId}/{notificationId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
Workspace ID
notificationId
string
required
Notification ID

Request body JSON required

title
optional
string
Updated notification title
message
optional
string
Updated notification message
type
optional
info
or
success
or
warning
or
error
Updated notification type
priority
optional
low
or
medium
or
high
or
urgent
Updated priority level
read
optional
boolean
Mark notification as read/unread

Returns

200

Notification updated successfully

JSON

success
optional
boolean
notification
optional
object
- id
  optional
  string
  Unique notification identifier
- workspace_id
  optional
  string
  Workspace ID
- title
  optional
  string
  Notification title
- message
  optional
  string
  Notification message content
- type
  optional
  info
  or
  success
  or
  warning
  or
  error
  Notification type
- priority
  optional
  low
  or
  medium
  or
  high
  or
  urgent
  Notification priority level
- read
  optional
  boolean
  Whether notification has been read
  
  default: false
- dismissed
  optional
  boolean
  Whether notification has been dismissed
  
  default: false
- created_at
  optional
  string
  Notification creation timestamp
  
  format: date-time
- updated_at
  optional
  string
  Last update timestamp
  
  format: date-time
}
message
optional
string

404

Notification not found

500

Server error

Update notification

curl --request PUT \
  --url 'https://api.channelautomation.com/api/notifications/<workspaceId>/<notificationId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "string",
  "message": "string",
  "type": "info",
  "priority": "low",
  "read": true
}
'

const url = 'https://api.channelautomation.com/api/notifications/<workspaceId>/<notificationId>';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({title: 'string', message: 'string', type: 'info', priority: 'low', read: true})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/notifications/<workspaceId>/<notificationId>"

payload = {
    "title": "string",
    "message": "string",
    "type": "info",
    "priority": "low",
    "read": True
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "notification": {
    "id": "string",
    "workspace_id": "string",
    "title": "New Message Received",
    "message": "You have received a new message from John Doe",
    "type": "info",
    "priority": "medium",
    "read": false,
    "dismissed": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "message": "string"
}