eazy2biz-docs
  1. Customer Table
eazy2biz-docs
  • Getting Started
  • Overview
  • Authentication
  • Pagination
  • Querying and Sorting
  • Rate Limit
  • Scope
  • Identity
    • Identity Overview
    • Global User Token
      POST
    • Global User Offline Token
      POST
    • System Local User Offline Token (Company Impersonation)
      POST
    • API Client Access Offline Token
      POST
  • Activity
    • Create Activity
    • Filter Activities
    • Get All Activities for Entity
    • Get Activity for Entity by ID
    • Patch Activity Attributes for Entity by ID
    • Delete Activity for Entity by ID
  • Analytics
    • Chart
      • Get Charts in Report
      • Get Count of Charts in Report
      • Get Filtered Charts in Report
      • Get Count of Filtered Charts in Report
      • Simulate Chart in Report
      • Create Chart in Report
      • Get Chart in Report by ID
      • Get Chart Data in Report
      • Patch Chart Attributes in Report by ID
      • Delete Chart in Report by ID
    • Report
      • Get All Reports
      • Get Count of Reports
      • Create Report
      • Filter All Reports
      • Count of Filtered All Reports
      • Get Report by ID
      • Patch Report Attributes by ID
      • Delete Report by ID
  • Attachment
    • Create Attachment
    • Get all Attachments
    • Get count of all Attachments
    • Filter All Attachments
    • Count of Filtered Attachments
    • Get Attachment by ID
    • Download Attachment by ID
    • Patch Attachment Attributes by ID
    • Delete Attachment by ID
  • Customer Table
    • Create Customer Table
      POST
    • Get All Customer Tables
      GET
    • Get Count of All Customer Tables
      GET
    • Get Customer Table by ID
      GET
    • Patch Customer Table Attributes by ID
      PATCH
    • Delete Customer Table by ID
      DELETE
    • Add header to Customer Table
      POST
    • Get all Customer Table Headers
      GET
    • Get Customer Table Header by ID
      GET
    • Patch Customer Table Header Attributes by ID
      PATCH
    • Delete Customer Table Header by ID
      DELETE
    • Add Record to Customer Table
      POST
    • Get All Records in Customer Table
      GET
    • Get Count of All Records in Customer Table
      GET
    • Get Record in Customer Table by ID
      GET
    • Filter Records in Customer Table
      POST
    • Count of Filtered Records in Customer Table
      POST
    • Patch Record Attributes in Customer Table by ID
      PATCH
    • Delete Record in Customer Table by ID
      DELETE
  • Card
    • Override Stage Completion
    • Override Form Fields
    • Get All Cards In Workflow
    • Get Count of All Cards In Workflow
    • Filter All Cards In Workflow
    • Count of Filtered Cards In Workflow
    • Create Card In Workflow
    • Get Card In Workflow by ID
    • Patch Card Attributes In Workflow by ID
    • Delete Card In Workflow by ID
  • User Invite
    • Invite User To Company
    • Filter All Invites
    • Accept User Invite
    • Reject User Invite Copy
    • Get All User Invites
    • Get User Invite by ID
  • Global User Invite
    • Create Global User Invite
    • Get All Global User Invites
    • Count of all Global User Invites
    • Filter All Global User Invites
    • Count of Filtered Global User Invites
    • Reject Global User Invite
    • Get Global User Invite by ID
    • Delete Global User Invite by ID
  • Identities
    • Company
      • Get All Companies
      • Create Company
      • Get Companies For Global User
      • Get Company by ID
      • Patch Company Attributes
      • Delete company by ID
    • Company Settings
      • Create Company Setting
      • Get All Company Settings
      • Filter All Company Settings
      • Get Company Setting by Type
      • Get Company Setting by ID
      • Patch Company Setting by Type
      • Patch Company Setting by ID
      • Delete Company Setting by Type
      • Delete Company Setting by ID
    • Global User
      • Get All Global Users
      • Get Count Of All Global Users
      • Sign Up Global User
      • Resend Confirmation Passcode
      • Confirm Sign Up
      • Sign In
      • Refresh Token
      • Change password
      • Initiate Forward Password
      • Confirm Forgot Password
      • Get Global User By Email
      • Get Global User by Token
      • Add Mobile App Device Token
      • Remove Mobile App Device Token
      • Get Global User By ID
      • Patch Global User Attributes
      • Delete Global User By ID
    • Local User
      • Get All Local Users
      • Filter Local Users
      • Get Local Users by ID
      • Patch Local User Attributes by ID
      • Delete Local Users by ID
    • Security Group
      • Get all Security Groups
      • Create Security Group
      • Filter Security Groups
      • Add Local User in Security Group
      • Remove Local User in Security Group
      • Add User Group in Security Group
      • Remove User Group in Security Group
      • Check if Local User can perform Action on Feature
      • Check if Local User can perform Action on Feature Batch
      • Get All Actions Local User can perform on feature
      • Get all Security Groups by Feature & Action
      • Get Security Group by ID
      • Get Security Group by ID Copy
    • User Group
      • Get all User Groups
      • Create User Group
      • Filter User Groups
      • Add Local User to User Group
      • Remove Local User from User Group
      • Add User Group to User Group
      • Remove Local User from User Group Copy
      • Check Local User Membership in User Group
      • Get all User Groups a Local User is member of
      • Get all User Groups a Local User is directly member of
      • Get all User Groups a User Group is member of
      • Create User Group by ID
      • Patch User Group Attributes by ID
      • Delete User Group by ID
  • Template
    • WhatsApp
      • Get Status of WhatsApp Template
      • Send WhatsApp Message on Phone Number
    • Create Template
    • Create Template from System Template
    • Get All Templates in Category
    • Get Count of All Templates in Category
    • Filter All Templates in Category
    • Count of Filtered Templates in Category
    • Get Templates by ID in Category
    • Resolve Template by ID
    • Patch Templates Attributes by ID in Category
    • Delete Templates by ID in Category
  • Schedulable Trigger
    • Create Schedulable Trigger
    • Get all Schedulable Triggers
    • Get count of all Schedulable Triggers
    • Filter all Schedulable Triggers
    • Count of Filtered Schedulable Triggers
    • Get Schedulable Trigger by ID
    • Patch Schedulable Trigger Attribute by ID
    • Delete Schedulable Trigger by ID
  • User Todo
    • Create User Todo
    • Get All User Todos
    • Get Count of All User Todos
    • Filter All User Todos
    • Count of Filtered User Todos
    • Complete User Todo
    • Get User Todo by ID
    • Patch User Todo Attributes by ID
    • Delete User Todo by ID
  • Workflow
    • Stages
      • Get Workflow Stages by Workflow ID
      • Get All Workflow Stages by Workflow ID
      • Get Stage Form for Workflow Stage
    • Get All Workflows
    • Create Workflow
    • Filter All Workflows
    • Count of Filtered Workflows
    • Get Workflow by ID
    • Patch Workflow Attributes by ID
    • Delete Workflow by ID
  1. Customer Table

Create Customer Table

QAL
https://api.qal.eazy2biz.com
QAL
https://api.qal.eazy2biz.com
POST
/v1/customerTables
Create a customer table

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
name
string 
required
description
string 
optional
tableHeaders
array[object (CustomerTableHeader) {5}] 
required
>= 1 items
_id
string 
required
name
string 
required
headerType
enum<string> 
required
Allowed values:
NUMBERTEXTLONG_TEXTEMAILPHONE_NUMBERFILEFIRST_NAMELAST_NAMEFULL_NAMEDATETIMERADIODROPDOWN
helpText
string 
optional
validations
array[object (CustomerTableHeaderValidation) {2}] 
required
titleTableHeaderId
string 
required
tags
array[object (Tag) {2}] 
required
name
string 
required
colour
string 
required
Example
{
    "name": "string",
    "description": "string",
    "tableHeaders": [
        {
            "_id": "string",
            "name": "string",
            "headerType": "NUMBER",
            "helpText": "string",
            "validations": [
                {
                    "headerValidationType": "REQUIRED",
                    "validationValue": "string"
                }
            ]
        }
    ],
    "titleTableHeaderId": "string",
    "tags": [
        {
            "name": "string",
            "colour": "string"
        }
    ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.qal.eazy2biz.com/v1/customerTables' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "name": "string",
    "description": "string",
    "tableHeaders": [
        {
            "_id": "string",
            "name": "string",
            "headerType": "NUMBER",
            "helpText": "string",
            "validations": [
                {
                    "headerValidationType": "REQUIRED",
                    "validationValue": "string"
                }
            ]
        }
    ],
    "titleTableHeaderId": "string",
    "tags": [
        {
            "name": "string",
            "colour": "string"
        }
    ]
}'

Responses

🟢200Success
application/json
Body
_id
string 
required
tableHeaders
array[object (CustomerTableHeader) {5}] 
required
_id
string 
required
name
string 
required
headerType
enum<string> 
CustomerTableHeaderTypes
required
Allowed values:
NUMBERTEXTLONG_TEXTEMAILPHONE_NUMBERFILEFIRST_NAMELAST_NAMEFULL_NAMEDATETIMERADIODROPDOWN
helpText
string 
optional
validations
array[object (CustomerTableHeaderValidation) {2}] 
required
titleTableHeaderId
string 
required
tags
array[object (Tag) {2}] 
required
name
string 
required
colour
string 
required
details
object 
Details
required
name
string 
required
companyId
number 
required
description
string 
optional
metaData
object 
MetaData
required
createdBy
string 
required
lastUpdatedBy
string 
required
createdDate
string <date-time>
required
lastUpdatedDate
string <date-time>
required
version
number 
required
enabled
boolean 
required
Example
{
    "_id": "string",
    "tableHeaders": [
        {
            "_id": "string",
            "name": "string",
            "headerType": "NUMBER",
            "helpText": "string",
            "validations": [
                {
                    "headerValidationType": "REQUIRED",
                    "validationValue": "string"
                }
            ]
        }
    ],
    "titleTableHeaderId": "string",
    "tags": [
        {
            "name": "string",
            "colour": "string"
        }
    ],
    "details": {
        "name": "string",
        "companyId": 0,
        "description": "string"
    },
    "metaData": {
        "createdBy": "string",
        "lastUpdatedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastUpdatedDate": "2019-08-24T14:15:22Z",
        "version": 0
    },
    "enabled": true
}
Modified at 2024-07-08 17:49:30
Previous
Delete Attachment by ID
Next
Get All Customer Tables
Built with