Shyft Customer > Chats > ChatSessions API
The Customer > Chats > ChatSessions API from Shyft — 5 operation(s) for customer > chats > chatsessions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shyft-customer-chats-chatsessions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Shyft Customer Customer > Chats > ChatSessions API
description: Welcome to the Shyft Customer App API.
version: 1.0.0
servers:
- url: http://{{host}}
- url: http://{{local-host}}
- url: http://{{sp3-host}}
- url: http://test-service.myshyft.com
- url: http://localhost:4001
- url: http://localhost:3000
- url: http://{{local-host}}api
- url: https://test-unfurl.myshyft.com
tags:
- name: Customer > Chats > ChatSessions
paths:
/api/customer/user_role/chat_sessions:
post:
tags:
- Customer > Chats > ChatSessions
summary: create a chat session
description: 'Description
- - -
- Ceate a chat session between two users
- Return error with existing session ID if same group users session exists
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---
title | | | Chat session title|
user_ids | | | array of both user ids. Ex. [9594, 9568] |'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"chat_session\": { \n \"user_ids\": [9540, 9568]\n }\n}"'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'201':
description: Created
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: '{{x_method}}'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
ETag:
schema:
type: string
example: W/"3c4804471860ed29e06f2d9766cff29b"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=TGJaQnRJdlhueHFRN012ek0wNFJCZlhvMDQrUHV6UjdTUEtZOXVhRUhBWHVVeXpmRzdvNFAvY21va2o0YnBXWXovUnB4aFc5bXdEN0c5WnZha05Cb3c9PS0tZUhGY3pscXp4SHp6VHJLQm1DclRoUT09--8741d3aa3e25386f70afc2804e97c18d14fdf7ef; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: Bin%27s+Local+Server
X-Request-Id:
schema:
type: string
example: 41798aad-7fee-4e8f-9a04-f27259798e10
X-Runtime:
schema:
type: number
example: '0.903121'
Vary:
schema:
type: string
example: Origin
Connection:
schema:
type: string
example: close
Server:
schema:
type: string
example: thin 1.5.1 codename Straight Razor
content:
application/json:
schema:
type: object
example:
chat_session:
_parent_object_id: null
id: 3034
org_id: 1
message_count: 0
participant_count: 0
title: null
latest_message: null
multiuser_chat: false
updated_at: '2018-11-03T04:00:30.259Z'
srn: null
participants:
- _parent_object_id: 3034
id: 9660
session_id: 3034
unread_count: 0
owner:
_parent_object_id: 9660
id: 9540
active_org: 0
first_name: Bin
last_name: Li
email: bin@myshyft.com
gender: 0
user_group: 0
profile_image: null
recent_user_privilege: null
- _parent_object_id: 3034
id: 9661
session_id: 3034
unread_count: 0
owner:
_parent_object_id: 9661
id: 9568
active_org: 0
first_name: Bin
last_name: Li
email: bin6080@myshyft.com
phone_number: '18083836511'
gender: 0
chat_handle: 38d65ba6e1369bb0ac883c70c983a3c3
user_group: 0
status: ''
profile_image: null
recent_user_privilege:
_associations_removed: true
_parent_object_id: 9568
id: 11342
email: bin6080@myshyft.com
wage: 15
position: null
is_approved: true
owner_id: 9568
location_id: 2634
org_id: 1
is_admin: false
read_only: false
first_name: Bin
last_name: Li
phone_number: '18083836511'
profile_image_thumb_url: https://s3.amazonaws.com/shyftassets/avatar1.png
admin_claim_pending: false
'422':
description: Unprocessable Entity (WebDAV) (RFC 4918)
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: '{{x_method}}'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Cache-Control:
schema:
type: string
example: no-cache
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=MURENHNLYS9nUVIzOXkwa2tIMHJkM2ZtdkNsbVcwaldwRXJPbVViaUJDWEFHNjdVSWM4SVBBZmprZ0pkSSt4T2dFaDRBakV4bXFuUWxBdWUxUXdZT1E9PS0tRjJZTnNRb3RTMkpaWTNpM0wrcjFQUT09--a81301b11cf21ba491e4e5c6d00c49c7c1634cfe; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: Bin%27s+Local+Server
X-Request-Id:
schema:
type: string
example: 88d567e3-f4f1-4ce3-a18e-69351e4cfe86
X-Runtime:
schema:
type: number
example: '0.376401'
Vary:
schema:
type: string
example: Origin
Connection:
schema:
type: string
example: close
Server:
schema:
type: string
example: thin 1.5.1 codename Straight Razor
content:
application/json:
schema:
type: object
example:
errors:
base:
- 'a private session for same two users already exists: 3033'
operationId: postApiCustomerUserRoleChatSessions
x-operation-id-source: derived
get:
tags:
- Customer > Chats > ChatSessions
summary: get chat sessions
description: 'Description
- - -
- Get all associated chat sessions
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: '{{x_method}}'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
ETag:
schema:
type: string
example: W/"612f5da36ba12b893553b241f84ff69a"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=cG8rb0cvNzhvWTRMNXl0WHZ6Y2tsNEZHY1hmUGpLYkE3VHk1SWtlQTA4Rjh2NTJMWGd6cjdlUzNBVENNMXVCTmJSLzVac2xTYVFxK29tZnVBb0IyU0E9PS0tcXdJVnNRZ3VVNmJuMWVYYWljTEZlZz09--910f0ae3ad241b6d7f8a125966781daa4de2b8d6; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: Bin%27s+Local+Server
X-Request-Id:
schema:
type: string
example: c1ee3ce4-0762-4904-abe7-88a9ac66f2cf
X-Runtime:
schema:
type: number
example: '9.842856'
Vary:
schema:
type: string
example: Origin
Connection:
schema:
type: string
example: close
Server:
schema:
type: string
example: thin 1.5.1 codename Straight Razor
content:
application/json:
schema:
type: object
example:
chat_sessions:
- _associations_removed: true
_parent_object_id: null
id: 3033
org_id: 1
message_count: 0
participant_count: 2
title: hello world
latest_message: null
multiuser_chat: false
updated_at: '2018-11-01T21:50:10.284Z'
srn: c3bb3cdb-5358-4fae-b7c2-57f50da36a93
operationId: getApiCustomerUserRoleChatSessions
x-operation-id-source: derived
/api/customer/user_role/chat_sessions/76:
get:
tags:
- Customer > Chats > ChatSessions
summary: get a chat session
description: 'Description
- - -
- Get a chat sessions
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: getApiCustomerUserRoleChatSessions76
x-operation-id-source: derived
/api/customer/user_role/chat_sessions//{chat_session_id}/archive:
put:
tags:
- Customer > Chats > ChatSessions
summary: archive a chat sessions
description: 'Description
- - -
- Archive a chat session
- Removed from user''s chat sessions list
- Will be added back when there is a new message added, can still see history messages
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
requestBody:
content:
'*/*':
schema:
type: string
example: '""'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putApiCustomerUserRoleChatSessionsByChatSessionIdArchive
x-operation-id-source: derived
/api/customer/user_role/chat_sessions/{chat_session_id}/quit:
put:
tags:
- Customer > Chats > ChatSessions
summary: quit a chat sessions
description: 'Description
- - -
- Quit a chat session
- Removed from user''s chat sessions list
- Will be added back when there is a new message added, but not see history messages any more
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
requestBody:
content:
'*/*':
schema:
type: string
example: '""'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putApiCustomerUserRoleChatSessionsByChatSessionIdQuit
x-operation-id-source: derived
/api/customer/user_role/chat_sessions/{chat_session_id}/read_all:
put:
tags:
- Customer > Chats > ChatSessions
summary: read all a chat session
description: 'Description
- - -
- Mark all messages as read for this chat session
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
requestBody:
content:
'*/*':
schema:
type: string
example: '""'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putApiCustomerUserRoleChatSessionsByChatSessionIdReadAll
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth