/
ON
onboard
/
Onboard API - Complete Specification
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2h ago · Updated 21h ago
Details
Filter operations
Activity
2
Assets
12
Billing
2
Bots
66
Comments
22
Communication Records
18
Conversations
14
get
GET /conversations
options
OPTIONS /conversations
get
GET /conversations/{id}
put
PUT /conversations/{id}
options
OPTIONS /conversations/{id}
patch
PATCH /conversations/{id}
get
GET /conversations/{id}/messages
options
OPTIONS /conversations/{id}/messages
post
POST /messages/{id}/feedback
options
OPTIONS /messages/{id}/feedback
get
GET /widget-conversation-messages
options
OPTIONS /widget-conversation-messages
post
POST /chat
options
OPTIONS /chat
Custom
14
Email
25
Forms
15
Hooks
12
Knowledge Base
23
Map
271
Platform
105
Stats
46
Workflows
32
Conversations
PATCH /conversations/{id}
PATCH operation for /conversations/{id}
patch
/conversations/{id}
Path parameters
id
string
required
Request body
ConversationSerializer
required
id
integer
bot
string
required
visitor_id
string
required
email
string
email
status
'open'
|
'closed'
|
'archived'
ended_at
string
date-time
message_count
integer
messages
string
created_at
string
date-time
modified_at
string
date-time
Response
Successful response
ConversationSerializer
required
id
integer
bot
string
required
visitor_id
string
required
email
string
email
status
'open'
|
'closed'
|
'archived'
ended_at
string
date-time
message_count
integer
messages
string
created_at
string
date-time
modified_at
string
date-time
Changes