Skip to content

Try “workflows”, “templates”, “SOQL” or “create a record”.

Team Inbox

Internal threads, channels and direct messages.

List org members (team inbox)

GET/team-inbox/members
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/threads
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-only

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Request body

FieldType
namestring
topicstring
descriptionstring
archivedboolean
visibility"public" | "private"
postPolicy"everyone" | "admins"

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/messages
Scope team_inbox:viewRead-only

Path parameters

NameType
idrequiredstring

Query parameters

NameType
limitnumber
cursorstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/messages
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
textstring
clientIdstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/dm
Scope team_inbox:sendWrites data

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/channels
Scope team_inbox:viewRead-only

Query parameters

NameType
querystring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/channels
Scope team_inbox:sendWrites data

Request body

FieldType
namestring
visibility"public" | "private"

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/join
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-only

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Request body

FieldType
textrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-unread
Scope team_inbox:viewWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
messageIdstring
atstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/replies
Scope team_inbox:viewRead-only

Path parameters

NameType
idrequiredstring

Query parameters

NameType
cursorstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-view
Scope team_inbox:viewRead-only

Query parameters

NameType
cursorstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/drafts
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/drafts
Scope team_inbox:sendWrites data

Request body

FieldType
chatIdrequiredstring
parentMessageIdstring
textstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/scheduled
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/scheduled
Scope team_inbox:sendWrites data

Request body

FieldType
chatIdrequiredstring
scheduledAtrequiredstring
textstring
parentMessageIdstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Request body

FieldType
scheduledAtstring
textstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-now
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/sent
Scope team_inbox:viewRead-only

Query parameters

NameType
limitnumber

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/activity
Scope team_inbox:viewRead-only

Query parameters

NameType
unreadOnlynumber
cursorstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/read
Scope team_inbox:viewWrites data

Request body

FieldType
idsarray of string

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/saved
Scope team_inbox:viewRead-only

Query parameters

NameType
state"in_progress" | "completed" | "archived"

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/saved
Scope team_inbox:viewWrites data

Request body

FieldType
messageIdrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Request body

FieldType
state"in_progress" | "completed" | "archived"
remindAtstring | null

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/unreads
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-all
Scope team_inbox:viewWrites data

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not found
curl
curl -X POST "https://api.klerc.co/api/v1/team-inbox/threads/read-all" \  -H "Authorization: Bearer $KLERC_TOKEN"

My sidebar layout prefs (sections/starred/collapsed)

GET/team-inbox/sidebar
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not found
curl
curl -X GET "https://api.klerc.co/api/v1/team-inbox/sidebar" \  -H "Authorization: Bearer $KLERC_TOKEN"

Save sidebar layout prefs (partial)

PUT/team-inbox/sidebar
Scope team_inbox:viewWrites data

Request body

FieldType
sectionsarray of object
starredChatIdsarray of string
collapsedKeysarray of string

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not found
curl
curl -X PUT "https://api.klerc.co/api/v1/team-inbox/sidebar" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"sections":[{}],"starredChatIds":["…"],"collapsedKeys":["…"]}'

Set my notification level and/or chime toggle for a conversation

PUT/team-inbox/threads/{id}/notify
Scope team_inbox:viewWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
notify"all" | "mentions" | "none"
soundboolean

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/pins
Scope team_inbox:viewRead-only

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/pins
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
messageIdrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring
messageIdrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/bookmarks
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
titlerequiredstring
urlrequiredstring
emojistring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring
bookmarkIdrequiredstring

Request body

FieldType
titlestring
urlstring
emojistring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring
bookmarkIdrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not found
curl
curl -X DELETE "https://api.klerc.co/api/v1/team-inbox/threads/{id}/bookmarks/{bookmarkId}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Toggle my emoji reaction on a message

POST/team-inbox/messages/{id}/reactions
Scope team_inbox:sendWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
emojirequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/read
Scope team_inbox:viewWrites data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/members
Scope team_inbox:manageWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
memberIdsrequiredarray of string

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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 data

Path parameters

NameType
idrequiredstring
userIdrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/presence
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-count
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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}/follow
Scope team_inbox:viewWrites data

Path parameters

NameType
idrequiredstring

Request body

FieldType
followingrequiredboolean

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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-replies
Scope team_inbox:viewWrites data

Path parameters

NameType
idrequiredstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/status
Scope team_inbox:viewWrites data

Request body

FieldType
emojistring
textstring
clearAtstring

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/preferences
Scope team_inbox:viewRead-only

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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/preferences
Scope team_inbox:viewWrites data

Request body

FieldType
quietStartstring | null
quietEndstring | null
tzstring | null
soundsboolean
markReadBehavior"auto" | "manual"
dndUntilstring | null

Responses

  • 200OK
  • 201Created
  • 401Authentication failed
  • 403Insufficient scope / feature disabled
  • 404Not 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":"…"}'