Team Inbox
Internal threads, channels and direct messages.
- GET
/team-inbox/members - GET
/team-inbox/threads - GET
/team-inbox/threads/{id} - PATCH
/team-inbox/threads/{id} - GET
/team-inbox/threads/{id}/messages - POST
/team-inbox/threads/{id}/messages - POST
/team-inbox/dm - GET
/team-inbox/channels - POST
/team-inbox/channels - POST
/team-inbox/channels/{id}/join - GET
/team-inbox/messages/{id} - PATCH
/team-inbox/messages/{id} - DELETE
/team-inbox/messages/{id} - POST
/team-inbox/threads/{id}/mark-unread - GET
/team-inbox/messages/{id}/replies - GET
/team-inbox/threads-view - GET
/team-inbox/drafts - PUT
/team-inbox/drafts - DELETE
/team-inbox/drafts/{id} - GET
/team-inbox/scheduled - POST
/team-inbox/scheduled - PATCH
/team-inbox/scheduled/{id} - DELETE
/team-inbox/scheduled/{id} - POST
/team-inbox/scheduled/{id}/send-now - GET
/team-inbox/sent - GET
/team-inbox/activity - POST
/team-inbox/activity/read - GET
/team-inbox/saved - POST
/team-inbox/saved - PATCH
/team-inbox/saved/{id} - DELETE
/team-inbox/saved/{id} - GET
/team-inbox/unreads - POST
/team-inbox/threads/read-all - GET
/team-inbox/sidebar - PUT
/team-inbox/sidebar - PUT
/team-inbox/threads/{id}/notify - GET
/team-inbox/threads/{id}/pins - POST
/team-inbox/threads/{id}/pins - DELETE
/team-inbox/threads/{id}/pins/{messageId} - POST
/team-inbox/threads/{id}/bookmarks - PATCH
/team-inbox/threads/{id}/bookmarks/{bookmarkId} - DELETE
/team-inbox/threads/{id}/bookmarks/{bookmarkId} - GET
/team-inbox/search - POST
/team-inbox/messages/{id}/reactions - POST
/team-inbox/threads/{id}/read - POST
/team-inbox/threads/{id}/members - DELETE
/team-inbox/threads/{id}/members/{userId} - GET
/team-inbox/presence - GET
/team-inbox/unread-count - POST
/team-inbox/messages/{id}/follow - POST
/team-inbox/messages/{id}/read-replies - PUT
/team-inbox/status - GET
/team-inbox/preferences - PUT
/team-inbox/preferences
List org members (team inbox)
GET
/team-inbox/membersScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/members" \ -H "Authorization: Bearer $KLERC_TOKEN"List team-inbox threads
GET
/team-inbox/threadsScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/threads" \ -H "Authorization: Bearer $KLERC_TOKEN"Get a team-inbox thread
GET
/team-inbox/threads/{id}Scope
team_inbox:viewRead-onlyPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/threads/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"Update a thread (name/topic/description/archived/visibility/postPolicy)
PATCH
/team-inbox/threads/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
name | string |
topic | string |
description | string |
archived | boolean |
visibility | "public" | "private" |
postPolicy | "everyone" | "admins" |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PATCH "https://api.klerc.co/api/v1/team-inbox/threads/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"…","topic":"…","description":"…","archived":false,"visibility":"public","postPolicy":"everyone"}'List messages in a team thread
GET
/team-inbox/threads/{id}/messagesScope
team_inbox:viewRead-onlyPath parameters
| Name | Type |
|---|---|
idrequired | string |
Query parameters
| Name | Type |
|---|---|
limit | number |
cursor | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/threads/{id}/messages?limit=25" \ -H "Authorization: Bearer $KLERC_TOKEN"Send a team-inbox message
POST
/team-inbox/threads/{id}/messagesScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
text | string |
clientId | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/messages" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"text":"…","clientId":"…"}'Start a direct message
POST
/team-inbox/dmScope
team_inbox:sendWrites dataResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/dm" \ -H "Authorization: Bearer $KLERC_TOKEN"Browse channels (public + mine)
GET
/team-inbox/channelsScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
query | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/channels" \ -H "Authorization: Bearer $KLERC_TOKEN"Create a channel (pass visibility public|private) or legacy group
POST
/team-inbox/channelsScope
team_inbox:sendWrites dataRequest body
| Field | Type |
|---|---|
name | string |
visibility | "public" | "private" |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/channels" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"…","visibility":"public"}'Join a public channel
POST
/team-inbox/channels/{id}/joinScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/channels/{id}/join" \ -H "Authorization: Bearer $KLERC_TOKEN"Get one team-inbox message (permalink)
GET
/team-inbox/messages/{id}Scope
team_inbox:viewRead-onlyPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/messages/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"Edit my team-inbox message
PATCH
/team-inbox/messages/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
textrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PATCH "https://api.klerc.co/api/v1/team-inbox/messages/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"text":"…"}'Delete a team-inbox message (author or admin)
DELETE
/team-inbox/messages/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/messages/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"Mark a team thread unread from a message
POST
/team-inbox/threads/{id}/mark-unreadScope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
messageId | string |
at | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/mark-unread" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"messageId":"…","at":"…"}'List a message's thread replies
GET
/team-inbox/messages/{id}/repliesScope
team_inbox:viewRead-onlyPath parameters
| Name | Type |
|---|---|
idrequired | string |
Query parameters
| Name | Type |
|---|---|
cursor | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/messages/{id}/replies" \ -H "Authorization: Bearer $KLERC_TOKEN"My followed reply-threads (Threads view)
GET
/team-inbox/threads-viewScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
cursor | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/threads-view" \ -H "Authorization: Bearer $KLERC_TOKEN"List my team-inbox composer drafts
GET
/team-inbox/draftsScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/drafts" \ -H "Authorization: Bearer $KLERC_TOKEN"Save (upsert) a composer draft; empty text deletes it
PUT
/team-inbox/draftsScope
team_inbox:sendWrites dataRequest body
| Field | Type |
|---|---|
chatIdrequired | string |
parentMessageId | string |
text | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PUT "https://api.klerc.co/api/v1/team-inbox/drafts" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"chatId":"…","parentMessageId":"…","text":"…"}'Delete one of my drafts
DELETE
/team-inbox/drafts/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/drafts/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"List my scheduled team-inbox sends
GET
/team-inbox/scheduledScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/scheduled" \ -H "Authorization: Bearer $KLERC_TOKEN"Schedule a team-inbox message for later
POST
/team-inbox/scheduledScope
team_inbox:sendWrites dataRequest body
| Field | Type |
|---|---|
chatIdrequired | string |
scheduledAtrequired | string |
text | string |
parentMessageId | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/scheduled" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"chatId":"…","scheduledAt":"…","text":"…","parentMessageId":"…"}'Edit a pending scheduled send (time/text)
PATCH
/team-inbox/scheduled/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
scheduledAt | string |
text | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PATCH "https://api.klerc.co/api/v1/team-inbox/scheduled/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"scheduledAt":"…","text":"…"}'Cancel a pending scheduled send
DELETE
/team-inbox/scheduled/{id}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/scheduled/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"Send a scheduled message immediately
POST
/team-inbox/scheduled/{id}/send-nowScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/scheduled/{id}/send-now" \ -H "Authorization: Bearer $KLERC_TOKEN"My recently sent team-inbox messages
GET
/team-inbox/sentScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
limit | number |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/sent?limit=25" \ -H "Authorization: Bearer $KLERC_TOKEN"My activity feed (mentions/replies/reactions)
GET
/team-inbox/activityScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
unreadOnly | number |
cursor | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/activity" \ -H "Authorization: Bearer $KLERC_TOKEN"Mark activity read (all, or pass ids)
POST
/team-inbox/activity/readScope
team_inbox:viewWrites dataRequest body
| Field | Type |
|---|---|
ids | array of string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/activity/read" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"ids":["…"]}'My saved-for-later messages
GET
/team-inbox/savedScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
state | "in_progress" | "completed" | "archived" |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/saved" \ -H "Authorization: Bearer $KLERC_TOKEN"Save a message for later
POST
/team-inbox/savedScope
team_inbox:viewWrites dataRequest body
| Field | Type |
|---|---|
messageIdrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/saved" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"messageId":"…"}'Move a saved item between states and/or set a reminder
PATCH
/team-inbox/saved/{id}Scope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
state | "in_progress" | "completed" | "archived" |
remindAt | string | null |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PATCH "https://api.klerc.co/api/v1/team-inbox/saved/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"state":"in_progress","remindAt":"…"}'Remove a saved item
DELETE
/team-inbox/saved/{id}Scope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/saved/{id}" \ -H "Authorization: Bearer $KLERC_TOKEN"Unread conversations with their unread messages
GET
/team-inbox/unreadsScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/unreads" \ -H "Authorization: Bearer $KLERC_TOKEN"Mark every conversation read (returns previous watermarks for undo)
POST
/team-inbox/threads/read-allScope
team_inbox:viewWrites dataResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/read-all" \ -H "Authorization: Bearer $KLERC_TOKEN"Set my notification level and/or chime toggle for a conversation
PUT
/team-inbox/threads/{id}/notifyScope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
notify | "all" | "mentions" | "none" |
sound | boolean |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PUT "https://api.klerc.co/api/v1/team-inbox/threads/{id}/notify" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"notify":"all","sound":false}'Pinned messages in a conversation
GET
/team-inbox/threads/{id}/pinsScope
team_inbox:viewRead-onlyPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/threads/{id}/pins" \ -H "Authorization: Bearer $KLERC_TOKEN"Pin a message
POST
/team-inbox/threads/{id}/pinsScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
messageIdrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/pins" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"messageId":"…"}'Unpin a message
DELETE
/team-inbox/threads/{id}/pins/{messageId}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
messageIdrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/threads/{id}/pins/{messageId}" \ -H "Authorization: Bearer $KLERC_TOKEN"Add a bookmark to a conversation
POST
/team-inbox/threads/{id}/bookmarksScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
titlerequired | string |
urlrequired | string |
emoji | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/bookmarks" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"title":"…","url":"…","emoji":"…"}'Edit a bookmark
PATCH
/team-inbox/threads/{id}/bookmarks/{bookmarkId}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
bookmarkIdrequired | string |
Request body
| Field | Type |
|---|---|
title | string |
url | string |
emoji | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PATCH "https://api.klerc.co/api/v1/team-inbox/threads/{id}/bookmarks/{bookmarkId}" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"title":"…","url":"…","emoji":"…"}'Remove a bookmark
DELETE
/team-inbox/threads/{id}/bookmarks/{bookmarkId}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
bookmarkIdrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/threads/{id}/bookmarks/{bookmarkId}" \ -H "Authorization: Bearer $KLERC_TOKEN"Search team-inbox messages/files/channels/people
GET
/team-inbox/searchScope
team_inbox:viewRead-onlyQuery parameters
| Name | Type |
|---|---|
q | string |
tab | "messages" | "files" | "channels" | "people" |
from | string |
in | string |
before | string |
after | string |
fileType | string |
page | number |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/search" \ -H "Authorization: Bearer $KLERC_TOKEN"Toggle my emoji reaction on a message
POST
/team-inbox/messages/{id}/reactionsScope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
emojirequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/messages/{id}/reactions" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"emoji":"…"}'Mark a conversation read
POST
/team-inbox/threads/{id}/readScope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/read" \ -H "Authorization: Bearer $KLERC_TOKEN"Add members to a group/channel
POST
/team-inbox/threads/{id}/membersScope
team_inbox:manageWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
memberIdsrequired | array of string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/{id}/members" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"memberIds":["…"]}'Remove a member (or leave yourself)
DELETE
/team-inbox/threads/{id}/members/{userId}Scope
team_inbox:sendWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
userIdrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/threads/{id}/members/{userId}" \ -H "Authorization: Bearer $KLERC_TOKEN"User ids currently online in the org
GET
/team-inbox/presenceScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/presence" \ -H "Authorization: Bearer $KLERC_TOKEN"My unread/mention/thread/activity counters
GET
/team-inbox/unread-countScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/unread-count" \ -H "Authorization: Bearer $KLERC_TOKEN"Follow/unfollow a message thread
POST
/team-inbox/messages/{id}/followScope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Request body
| Field | Type |
|---|---|
followingrequired | boolean |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/messages/{id}/follow" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"following":false}'Mark a thread's replies read
POST
/team-inbox/messages/{id}/read-repliesScope
team_inbox:viewWrites dataPath parameters
| Name | Type |
|---|---|
idrequired | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/messages/{id}/read-replies" \ -H "Authorization: Bearer $KLERC_TOKEN"Set my custom status (empty clears)
PUT
/team-inbox/statusScope
team_inbox:viewWrites dataRequest body
| Field | Type |
|---|---|
emoji | string |
text | string |
clearAt | string |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PUT "https://api.klerc.co/api/v1/team-inbox/status" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"emoji":"…","text":"…","clearAt":"…"}'My team-inbox notification preferences + status
GET
/team-inbox/preferencesScope
team_inbox:viewRead-onlyResponses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/preferences" \ -H "Authorization: Bearer $KLERC_TOKEN"Save notification preferences (quiet hours/sounds/mark-read/DND pause)
PUT
/team-inbox/preferencesScope
team_inbox:viewWrites dataRequest body
| Field | Type |
|---|---|
quietStart | string | null |
quietEnd | string | null |
tz | string | null |
sounds | boolean |
markReadBehavior | "auto" | "manual" |
dndUntil | string | null |
Responses
200OK201Created401Authentication failed403Insufficient scope / feature disabled404Not found
curl
curl -X PUT "https://api.klerc.co/api/v1/team-inbox/preferences" \ -H "Authorization: Bearer $KLERC_TOKEN" \ -H "Content-Type: application/json" \ -d '{"quietStart":"…","quietEnd":"…","tz":"…","sounds":false,"markReadBehavior":"auto","dndUntil":"…"}'