Dashboard

Chats

Resources for interacting with other Skool accounts through the chat

Get Chats

get
Query parameters
pageintegerRequired
session_idstringRequired
Header parameters
x-api-secretstringRequired
Responses
200
Successful Response
application/json
get
GET /v1/chats/?page=1&session_id=text HTTP/1.1
Host: 
x-api-secret: text
Accept: */*

[
  {
    "id": "text",
    "last_message_id": "text",
    "user": {
      "id": "text",
      "username": "text",
      "first_name": "text",
      "last_name": "text",
      "picture_bubble": "text",
      "picture_profile": "text"
    }
  }
]

Get Chat Messages

get
Path parameters
chat_idstringRequired
Query parameters
message_idstringRequired
limitinteger · max: 50Required
session_idstringRequired
Header parameters
x-api-secretstringRequired
Responses
200
Successful Response
application/json
get
GET /v1/chats/{chat_id}?message_id=text&limit=1&session_id=text HTTP/1.1
Host: 
x-api-secret: text
Accept: */*

[
  {
    "id": "text",
    "author_id": "text",
    "content": "text"
  }
]

Send Chat Message

post
Path parameters
chat_idstringRequired
Query parameters
session_idstringRequired
Header parameters
x-api-secretstringRequired
Body
contentstringRequired
Responses
201
Successful Response
application/json
Responseany
post
POST /v1/chats/{chat_id}?session_id=text HTTP/1.1
Host: 
x-api-secret: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "content": "text"
}
No content

Read Chat

post
Path parameters
chat_idstringRequired
Query parameters
session_idstringRequired
Header parameters
x-api-secretstringRequired
Responses
204
Successful Response
post
POST /v1/chats/{chat_id}/read?session_id=text HTTP/1.1
Host: 
x-api-secret: text
Accept: */*

No content

Unread Chat

post
Path parameters
chat_idstringRequired
Query parameters
session_idstringRequired
Header parameters
x-api-secretstringRequired
Responses
204
Successful Response
post
POST /v1/chats/{chat_id}/unread?session_id=text HTTP/1.1
Host: 
x-api-secret: text
Accept: */*

No content
PreviousWebhooksNextPosts