/
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 22h ago
Details
Filter operations
Activity
2
Assets
12
Billing
2
Bots
66
Comments
22
Communication Records
18
Conversations
14
Custom
14
get
GET /custom/fields
post
POST /custom/fields
options
OPTIONS /custom/fields
get
GET /custom/fields/{id}
put
PUT /custom/fields/{id}
delete
DELETE /custom/fields/{id}
options
OPTIONS /custom/fields/{id}
patch
PATCH /custom/fields/{id}
post
POST /custom/fields/slugify
options
OPTIONS /custom/fields/slugify
get
GET /custom/fields/merge-tags
options
OPTIONS /custom/fields/merge-tags
get
GET /custom/fields/attachments/{file_name}
options
OPTIONS /custom/fields/attachments/{file_name}
Email
25
Forms
15
Hooks
12
Knowledge Base
23
Map
271
Platform
105
Stats
46
Workflows
32
Custom
DELETE /custom/fields/{id}
DELETE operation for /custom/fields/{id}
delete
/custom/fields/{id}
Path parameters
id
string
required
Response
Successful response
CustomFieldSerializer
required
id
integer
label
string
required
api_name
string
description
string
object
'customer'
|
'map'
|
'team_member'
|
'onboardee'
|
'map_task'
|
'task'
|
'section'
required
type
'number'
|
'text'
|
'dropdown'
|
'boolean'
|
'date'
|
'textarea'
|
'multiselect'
|
'attachment'
required
options
object
is_internal
boolean
is_active
boolean
created_at
string
date-time
tables_display_enabled
boolean
panels_display_enabled
boolean
outboard_display_enabled
boolean
map_types
string
Changes