Fields
CRM input field definitions
List available fields
Method
| URI |
Protocol |
Method |
Authentication |
/field/ |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
Get field details
Method
| URI |
Protocol |
Method |
Authentication |
/field/{id} |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
string |
PATH |
Type ID |
N/A |
YES |
Pages
CRM module pages
List available pages
Method
| URI |
Protocol |
Method |
Authentication |
/page/ |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
Create page
Method
| URI |
Protocol |
Method |
Authentication |
/page/ |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| selfID |
uint64 |
POST |
Parent Page ID |
N/A |
NO |
| moduleID |
uint64 |
POST |
Module ID (optional) |
N/A |
NO |
| title |
string |
POST |
Title |
N/A |
YES |
| description |
string |
POST |
Description |
N/A |
NO |
| visible |
bool |
POST |
Visible in navigation |
N/A |
NO |
| blocks |
types.JSONText |
POST |
Blocks JSON |
N/A |
YES |
Get page details
Method
| URI |
Protocol |
Method |
Authentication |
/page/{id} |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Page ID |
N/A |
YES |
Create page
Method
| URI |
Protocol |
Method |
Authentication |
/page/{id} |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Page ID |
N/A |
YES |
| selfID |
uint64 |
POST |
Parent Page ID |
N/A |
NO |
| moduleID |
uint64 |
POST |
Module ID (optional) |
N/A |
NO |
| title |
string |
POST |
Title |
N/A |
YES |
| description |
string |
POST |
Description |
N/A |
NO |
| visible |
bool |
POST |
Visible in navigation |
N/A |
NO |
| blocks |
types.JSONText |
POST |
Blocks JSON |
N/A |
YES |
Delete page
Method
| URI |
Protocol |
Method |
Authentication |
/page/{id} |
HTTP/S |
Delete |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Page ID |
N/A |
YES |
Modules
CRM module definitions
List modules
Method
| URI |
Protocol |
Method |
Authentication |
/module/ |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| query |
string |
GET |
Search query |
N/A |
NO |
Create module
Method
| URI |
Protocol |
Method |
Authentication |
/module/ |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| name |
string |
POST |
Module Name |
N/A |
YES |
| fields |
types.JSONText |
POST |
Fields JSON |
N/A |
YES |
Read module
Method
| URI |
Protocol |
Method |
Authentication |
/module/{id} |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Module ID |
N/A |
YES |
Edit module
Method
| URI |
Protocol |
Method |
Authentication |
/module/{id} |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Module ID |
N/A |
YES |
| name |
string |
POST |
Module Name |
N/A |
YES |
| fields |
types.JSONText |
POST |
Fields JSON |
N/A |
YES |
Delete module
Method
| URI |
Protocol |
Method |
Authentication |
/module/{id} |
HTTP/S |
DELETE |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| id |
uint64 |
PATH |
Module ID |
N/A |
YES |
List/read contents from module section
Method
| URI |
Protocol |
Method |
Authentication |
/module/{moduleID}/content |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| page |
int |
GET |
Page number (0 based) |
N/A |
NO |
| perPage |
int |
GET |
Returned items per page (default 50) |
N/A |
NO |
| moduleID |
uint64 |
PATH |
Module ID |
N/A |
YES |
List/read contents from module section
Method
| URI |
Protocol |
Method |
Authentication |
/module/{moduleID}/content |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| moduleID |
uint64 |
PATH |
Module ID |
N/A |
YES |
| fields |
types.JSONText |
POST |
Content JSON |
N/A |
YES |
Read contents by ID from module section
Method
| URI |
Protocol |
Method |
Authentication |
/module/{moduleID}/content/{id} |
HTTP/S |
GET |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| moduleID |
uint64 |
PATH |
Module ID |
N/A |
YES |
| id |
uint64 |
PATH |
Content ID |
N/A |
YES |
Add/update contents in module section
Method
| URI |
Protocol |
Method |
Authentication |
/module/{moduleID}/content/{id} |
HTTP/S |
POST |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| moduleID |
uint64 |
PATH |
Module ID |
N/A |
YES |
| id |
uint64 |
PATH |
Content ID |
N/A |
YES |
| fields |
types.JSONText |
POST |
Content JSON |
N/A |
YES |
Delete content row from module section
Method
| URI |
Protocol |
Method |
Authentication |
/module/{moduleID}/content/{id} |
HTTP/S |
DELETE |
|
Request parameters
| Parameter |
Type |
Method |
Description |
Default |
Required? |
| moduleID |
uint64 |
PATH |
Module ID |
N/A |
YES |
| id |
uint64 |
PATH |
Content ID |
N/A |
YES |
