Skip to main content
POST
Create custom module

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
name
string
required

Module name. Letters, numbers, spaces and - only. Example: Driver Dashboard

Maximum string length: 50
url
string
required

Page URL. May contain {SHORT_TOKEN}. Example: https://dashboard.example.com/?token={SHORT_TOKEN}

inputType
string

The input type of the component (e.g., string, number, date, etc.)

pluginId
string

Add-on ID. Required when type is ADDONS. Example: 68b440c9dad4c5d45707f6d2

target
enum<string>

Open in a new tab (_blank) or the same tab (_self). Default: _blank

Available options:
_blank,
_self

Response

Created

status
boolean
message
string
data
object

The new custom module.

permission
object

The view permission created for it.