Charcha endpoints

Every endpoint in Charcha: 82 operations across 24 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Conversations

GET/api/charcha/conversations

The conversations in one Charcha section, pinned first, then newest

curl -X GET https://app.jaicrm.ai/api/charcha/conversations 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/conversations/{id}

One conversation: its settings, its members and how far each has read, and what this person may do in it

curl -X GET https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/conversations/{id}/messages

The messages of a conversation, newest page first (pass before= to go back further)

curl -X GET https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/messages 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/conversations/browse

Open channels in the business that this person has not joined

curl -X GET https://app.jaicrm.ai/api/charcha/conversations/browse 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/conversations/manage

Every group and channel in the business, for someone allowed to run them all

curl -X GET https://app.jaicrm.ai/api/charcha/conversations/manage 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations

Make a group or a channel, with its first members

curl -X POST https://app.jaicrm.ai/api/charcha/conversations 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/catch-up

An AI summary of the messages you missed in a conversation, each line linked to its message

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/catch-up 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/checklists

Post a checklist: items ticked by hand, by a record, or by the day’s work

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/checklists 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/clear

Clear a conversation for this person only; others keep every message

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/clear 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/join

Join an open channel

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/join 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/members

Add people to a group or channel; adding to a direct chat turns it into a group

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/members/{userId}/remove

Remove someone from a group or channel, or leave it yourself

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/members/RECORD_ID/remove 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/messages

Send a message, a reply in a thread, or a reply quoting another message

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/messages 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/polls

Ask a question with choices; everybody here can vote and see the counts move

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/polls 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/read

Mark a conversation read up to its newest message, or up to a given moment

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/read 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/{id}/typing

Tell the others in a conversation that this person is typing

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/typing 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/conversations/direct

Open the direct chat with one colleague, starting it if there is none

curl -X POST https://app.jaicrm.ai/api/charcha/conversations/direct 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/charcha/conversations/{id}

Change a group or channel: name, about, who may post, delete and use @everyone

curl -X PATCH https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/charcha/conversations/{id}/me

Pin, mute, archive or mark a conversation unread, for this person only

curl -X PATCH https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/me 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/charcha/conversations/{id}/members/{userId}

Make a member an admin of a group or channel, or a member again

curl -X PATCH https://app.jaicrm.ai/api/charcha/conversations/RECORD_ID/members/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Messages

GET/api/charcha/messages/{id}/history

Every version of an edited message, with when each was written

curl -X GET https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/history 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/messages/{id}/seen

Who a message has reached and who has read it, with the date and time for each

curl -X GET https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/seen 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/messages/{id}/thread

A thread: the message that started it and every reply

curl -X GET https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/thread 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/close-poll

Close a poll you started (or run, as an admin); its result stays

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/close-poll 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/delete

Delete a message for yourself, or for everyone in the conversation

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/forward

Forward a message, with its files, to other chats, groups or channels

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/forward 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/pin

Pin a message to the top of its conversation, or unpin it

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/pin 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/reactions

Add a reaction to a message, or take yours away if it is already there

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/reactions 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/refresh

Read the records a message carries again and show everybody the change

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/refresh 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/task-drafts

AI drafts of the task or tasks a message asks for, to check before making any

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/task-drafts 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/vote

Vote in a poll, or change your vote (an empty list takes it back)

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/vote 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/messages/{id}/words

Write out a voice note (AI where the business allows it, else our own transcriber); the words arrive live

curl -X POST https://app.jaicrm.ai/api/charcha/messages/RECORD_ID/words 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/charcha/messages/{id}

Edit your own message; the earlier words are kept in its history

curl -X PATCH https://app.jaicrm.ai/api/charcha/messages/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Files

GET/api/charcha/files/{id}

Open or download a file sent in a conversation

curl -X GET https://app.jaicrm.ai/api/charcha/files/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/files/{provider}/browse

One folder of this person’s own Dropbox, to attach from

curl -X GET https://app.jaicrm.ai/api/charcha/files/RECORD_ID/browse 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/files/{provider}/picker

A short-lived token for Google’s own file picker, for this person’s own Drive

curl -X GET https://app.jaicrm.ai/api/charcha/files/RECORD_ID/picker 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/files/documents

Files in Documents that this person may attach, for the Charcha picker

curl -X GET https://app.jaicrm.ai/api/charcha/files/documents 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/files

Upload files into a conversation, ready to send with a message

curl -X POST https://app.jaicrm.ai/api/charcha/files 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/files/{provider}/attach

Copy files from this person’s own Google Drive or Dropbox into a conversation

curl -X POST https://app.jaicrm.ai/api/charcha/files/RECORD_ID/attach 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/files/from-documents

Attach files from Documents to a conversation; each is copied in, so it opens for everyone there

curl -X POST https://app.jaicrm.ai/api/charcha/files/from-documents 
  -H 'Authorization: Bearer YOUR_API_KEY'

Reminders

GET/api/charcha/reminders

Your reminders: due, coming up, and the ones you recently marked done

curl -X GET https://app.jaicrm.ai/api/charcha/reminders 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/reminders

Remind me about a message (or a chat) at a time

curl -X POST https://app.jaicrm.ai/api/charcha/reminders 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/reminders/{id}/done

Mark a reminder done

curl -X POST https://app.jaicrm.ai/api/charcha/reminders/RECORD_ID/done 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/reminders/{id}/snooze

Ring again later: a number of minutes from now, or a time

curl -X POST https://app.jaicrm.ai/api/charcha/reminders/RECORD_ID/snooze 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/reminders/{id}/undo

Put a reminder you marked done back on the list

curl -X POST https://app.jaicrm.ai/api/charcha/reminders/RECORD_ID/undo 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/charcha/reminders/{id}

Remove a reminder

curl -X DELETE https://app.jaicrm.ai/api/charcha/reminders/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Meetings

GET/api/charcha/meetings

Meetings this person organises or is invited to: upcoming, or past

curl -X GET https://app.jaicrm.ai/api/charcha/meetings 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/charcha/meetings/{id}/ics

A meeting as a calendar file (.ics) for Google Calendar, Outlook or a phone

curl -X GET https://app.jaicrm.ai/api/charcha/meetings/RECORD_ID/ics 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/meetings

Schedule a meeting with a link (Google Meet, Zoom or any other), posted in a chat if one is chosen

curl -X POST https://app.jaicrm.ai/api/charcha/meetings 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/meetings/{id}/cancel

Cancel a meeting you organise; everyone invited is told

curl -X POST https://app.jaicrm.ai/api/charcha/meetings/RECORD_ID/cancel 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/charcha/meetings/{id}

Change a meeting you organise: its time, link, title or reminder

curl -X PATCH https://app.jaicrm.ai/api/charcha/meetings/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Push

GET/api/charcha/push/key

The public key a browser needs to subscribe to Charcha notifications

curl -X GET https://app.jaicrm.ai/api/charcha/push/key 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/push/subscriptions

Turn on Charcha notifications for this browser

curl -X POST https://app.jaicrm.ai/api/charcha/push/subscriptions 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/push/unsubscribe

Turn off Charcha notifications for this browser

curl -X POST https://app.jaicrm.ai/api/charcha/push/unsubscribe 
  -H 'Authorization: Bearer YOUR_API_KEY'

Day report

GET/api/charcha/day-report

Your day so far, put together from your work, with where it goes

curl -X GET https://app.jaicrm.ai/api/charcha/day-report 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/day-report/draft

An AI draft of the note on your day report, from your work in JAI CRM today

curl -X POST https://app.jaicrm.ai/api/charcha/day-report/draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/day-report/send

Send your day report to your manager, a group or a channel; it remembers where

curl -X POST https://app.jaicrm.ai/api/charcha/day-report/send 
  -H 'Authorization: Bearer YOUR_API_KEY'

Shows

GET/api/charcha/shows/{eventId}

An exhibition’s stall channel: whether there is one, and whether you are in it

curl -X GET https://app.jaicrm.ai/api/charcha/shows/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/shows/{eventId}/join

Join an exhibition’s stall channel

curl -X POST https://app.jaicrm.ai/api/charcha/shows/RECORD_ID/join 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/shows/{eventId}/start

Make an exhibition’s stall channel now, rather than a fortnight before the show

curl -X POST https://app.jaicrm.ai/api/charcha/shows/RECORD_ID/start 
  -H 'Authorization: Bearer YOUR_API_KEY'

Record chats

GET/api/charcha/record-chats/{type}/{id}

The conversation about a lead, deal, task or invoice, if there is one, and whether you are in it

curl -X GET https://app.jaicrm.ai/api/charcha/record-chats/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/record-chats/{type}/{id}/join

Join the conversation about a lead, deal, task or invoice you can open

curl -X POST https://app.jaicrm.ai/api/charcha/record-chats/RECORD_ID/RECORD_ID/join 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/record-chats/{type}/{id}/start

Start the conversation about a lead, deal, task or invoice

curl -X POST https://app.jaicrm.ai/api/charcha/record-chats/RECORD_ID/RECORD_ID/start 
  -H 'Authorization: Bearer YOUR_API_KEY'

Me

GET/api/charcha/me

This person’s Charcha: how Enter behaves, their status, and what their role lets them do

curl -X GET https://app.jaicrm.ai/api/charcha/me 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/charcha/me

Set how Enter behaves in Charcha, and set or clear a status

curl -X PUT https://app.jaicrm.ai/api/charcha/me 
  -H 'Authorization: Bearer YOUR_API_KEY'

Settings

GET/api/charcha/settings

The business’s Charcha rules: the delete-for-everyone window and how long messages are kept

curl -X GET https://app.jaicrm.ai/api/charcha/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/charcha/settings

Change the business’s Charcha rules (administrators)

curl -X PUT https://app.jaicrm.ai/api/charcha/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

Broadcast

GET/api/charcha/broadcast/reach

Who this person may broadcast to: everyone under them, the level just below, or chosen people

curl -X GET https://app.jaicrm.ai/api/charcha/broadcast/reach 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/broadcast

Send one message to people under you; each gets it in their own chat and replies come back privately

curl -X POST https://app.jaicrm.ai/api/charcha/broadcast 
  -H 'Authorization: Bearer YOUR_API_KEY'

Checklists

GET/api/charcha/checklists/stages

The deal stages a checklist item can wait for

curl -X GET https://app.jaicrm.ai/api/charcha/checklists/stages 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/charcha/checklists/{id}/stop-repeating

Stop a checklist repeating; the ones already posted stay

curl -X POST https://app.jaicrm.ai/api/charcha/checklists/RECORD_ID/stop-repeating 
  -H 'Authorization: Bearer YOUR_API_KEY'

Summary

GET/api/charcha/summary

Unread counts for the Charcha badges: chats, groups, channels, broadcasts and in total

curl -X GET https://app.jaicrm.ai/api/charcha/summary 
  -H 'Authorization: Bearer YOUR_API_KEY'

Delivered

POST/api/charcha/delivered

Record that messages reached this person’s screen (the second tick)

curl -X POST https://app.jaicrm.ai/api/charcha/delivered 
  -H 'Authorization: Bearer YOUR_API_KEY'

Search

GET/api/charcha/search

Search the messages in every conversation this person is in

curl -X GET https://app.jaicrm.ai/api/charcha/search 
  -H 'Authorization: Bearer YOUR_API_KEY'

People

GET/api/charcha/people

Colleagues to start a chat with or mention, with their status and whether they are online

curl -X GET https://app.jaicrm.ai/api/charcha/people 
  -H 'Authorization: Bearer YOUR_API_KEY'

Broadcasts

GET/api/charcha/broadcasts

Broadcasts this person sent, with how many have read each, and the ones from above them

curl -X GET https://app.jaicrm.ai/api/charcha/broadcasts 
  -H 'Authorization: Bearer YOUR_API_KEY'

Records

GET/api/charcha/records

Find a record to share in a message: only ones you can open yourself

curl -X GET https://app.jaicrm.ai/api/charcha/records 
  -H 'Authorization: Bearer YOUR_API_KEY'

Checklist items

POST/api/charcha/checklist-items/{id}/tick

Tick an item on a checklist by hand, or take the tick back

curl -X POST https://app.jaicrm.ai/api/charcha/checklist-items/RECORD_ID/tick 
  -H 'Authorization: Bearer YOUR_API_KEY'

Visit rings

POST/api/charcha/visit-rings/{id}/snooze

Ring again about a visit in a few minutes

curl -X POST https://app.jaicrm.ai/api/charcha/visit-rings/RECORD_ID/snooze 
  -H 'Authorization: Bearer YOUR_API_KEY'

Visits

POST/api/charcha/visits/{id}/voice

Speak the notes of a visit: the recording is kept on it and its words are written out

curl -X POST https://app.jaicrm.ai/api/charcha/visits/RECORD_ID/voice 
  -H 'Authorization: Bearer YOUR_API_KEY'

Visit voice

POST/api/charcha/visit-voice/{id}/applied

The open window took the written-out words into the notes

curl -X POST https://app.jaicrm.ai/api/charcha/visit-voice/RECORD_ID/applied 
  -H 'Authorization: Bearer YOUR_API_KEY'

Ai

GET/api/charcha/ai

Which of Charcha’s AI jobs this business may use now (catching up, task drafts, the day note, voice)

curl -X GET https://app.jaicrm.ai/api/charcha/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'