Skip to content

help_box

Browse and manage help boxes

Create

Path
POST /v7.0/help_boxes
Description
Create a help box
Authentication required
yes
Scope
help_box#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
help_box
ParameterTypeRequiredDetails
page
Page
 String no

Default: null
action
Action
 String no

Default: null
language
Language
 Resource no
content
Content
 Text yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
order
Order
 Integer no

Template order

Default: null

Output parameters

Layout
object
Namespace
help_box
ParameterTypeDescription
id
Id
 Integer
page
Page
 String
action
Action
 String
language
Language
 Resource
content
Content
 Text
order
Order
 Integer Template order

Delete

Path
DELETE /v7.0/help_boxes/{help_box_id}
Description
Delete help box
Authentication required
yes
Scope
help_box#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/help_boxes
Description
List help boxes
Authentication required
no
Scope
help_box#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
help_box
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
page
Page
 String no

Default: null
action
Action
 String no

Default: null
language
Language
 Resource no
view
View
 Boolean no

When enabled, list help boxes for the current user, including page/action filters

Default: false

Output parameters

Layout
object_list
Namespace
help_boxes
ParameterTypeDescription
id
Id
 Integer
page
Page
 String
action
Action
 String
language
Language
 Resource
content
Content
 Text
order
Order
 Integer Template order

Show

Path
GET /v7.0/help_boxes/{help_box_id}
Description
Show helpbox
Authentication required
yes
Scope
help_box#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
help_box
ParameterTypeDescription
id
Id
 Integer
page
Page
 String
action
Action
 String
language
Language
 Resource
content
Content
 Text
order
Order
 Integer Template order

Update

Path
PUT /v7.0/help_boxes/{help_box_id}
Description
Update help box
Authentication required
yes
Scope
help_box#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
help_box
ParameterTypeRequiredDetails
page
Page
 String no

Default: null
action
Action
 String no

Default: null
language
Language
 Resource no
content
Content
 Text no

Default: null
order
Order
 Integer no

Template order

Default: null

Output parameters

Layout
object
Namespace
help_box
ParameterTypeDescription
id
Id
 Integer
page
Page
 String
action
Action
 String
language
Language
 Resource
content
Content
 Text
order
Order
 Integer Template order