Inbox Notifications

Mark a notification as Read/Unread

patch/inbox-notifications/{notification_id}

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/inbox-notifications/{notification_id}
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

notification_idstring required

Request body

is_readboolean required

Response

_idstring required
user_idstring required
type'workspace.user.added' | 'workspace.user.invited' | 'workspace.user.joined' | 'workspace.user.removed' | 'workspace.user.left' | 'workspace.findable-channel.created' | 'workspace.user.join.requested' | 'workspace.user.join.declined' | 'workspace.updated' | 'channel.user.joined' | 'channel.deleted' | 'channel.users.added' | 'channel.user.removed' | 'channel.user.left' | 'channel.updated' | 'channel.user.join.requested' | 'cv.user.joined' | 'general.new.update' | 'general.new.article' | 'general.user.tagged' | 'general.message.forwarded' required
workspace_idstring nullable
channel_idstring nullable
from_user_idstring nullable
removed_user_idstring nullable
added_user_idstring nullable
declined_user_idstring nullable
message_idstring nullable
parent_message_idstring nullable
messagestring required
created_atstring date-time required
last_updated_atstring date-time required
category'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general' required
is_readboolean nullable
action_urlstring nullable

Changes

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