Skip to main content
POST
Mark a notification unread

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the notification. Notifications are always scoped to the calling user.

Example:

1

Response

Success

id
integer

The numeric ID of the notification.

account_id
integer

The account the notification belongs to.

user_id
integer

The user the notification is for.

notification_type
enum<string>

What happened.

Available options:
conversation_creation,
conversation_assignment,
assigned_conversation_new_message,
conversation_mention,
participating_conversation_new_message,
sla_missed_first_response,
sla_missed_next_response,
sla_missed_resolution
primary_actor_type
string

Always Conversation today — it is the only primary actor the app creates notifications for.

primary_actor_id
integer

The conversation the notification is about.

secondary_actor_type
string | null

The message that triggered it, where one applies. Null when the system acted rather than a person.

secondary_actor_id
integer | null

ID of the secondary actor.

read_at
string | null

ISO-8601 timestamp of when it was read. Null while unread.

snoozed_until
string | null

ISO-8601 timestamp of when it should reappear. Null when not snoozed.

last_activity_at
string

ISO-8601 timestamp the feed is sorted by — it moves when a new message arrives on the same conversation.

meta
object

Internal bookkeeping, including last_snoozed_at.

created_at
string

ISO-8601 timestamp of creation.

updated_at
string

ISO-8601 timestamp of the last change.