Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create clients and groups

The platform allows you to manage pre-defined Clients and organize them into Groups

  • Pre-Defined Records: Clients are created and saved directly inside the system with their verified details (names, emails, identifiers).

  • Workflow Automation: Once a client is saved, you can instantly trigger and generate tasks for them without re-entering their information every time.

Create group

Body
{
  "Name":"Testing Group"    
}

ResponseObject will contain the groupID as Id

Create

post
Body
IdintegerRequiredExample: 1
UserIdstringOptionalExample: id_dfa8786a
ManagerIdstringOptionalExample: id_75975bb0
NamestringOptionalExample: John Doe
GroupClientsstringOptional
ClientsCounterintegerRequiredExample: 1
ClientsPhonesCounterintegerRequiredExample: 1
ClientsEmailsCounterintegerRequiredExample: 1
SignatureRoutinebooleanRequiredExample: true
APIResponsestringOptional
Responses
200

Success (No content returned)

No content

post/api/Groups/Create
POST /api/Groups/Create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "Id": 1,
  "UserId": "id_dfa8786a",
  "ManagerId": "id_75975bb0",
  "Name": "John Doe",
  "GroupClients": null,
  "ClientsCounter": 1,
  "ClientsPhonesCounter": 1,
  "ClientsEmailsCounter": 1,
  "SignatureRoutine": true,
  "APIResponse": null
}

No content

Create client

Create

post
Body
IdintegerRequiredExample: 1
UserIdstringOptionalExample: id_4059ba53
ManagerIdstringOptionalExample: id_1b3efe3b
NamestringOptionalExample: John Doe
CompNumstringOptionalExample: sample_compnum
EmailsstringOptionalExample: client@example.com
PhonesstringOptionalExample: sample_phones
ClientsstringOptional
APIResponsestringOptional
Responses
200

Success (Custom Example)

application/json
stringOptionalExample: { "Status": "success", "Message": "", "ResponseObject": { "Id": 316258, "UserId": "xxxxx-4c4a-4e9a-a254-2222222", "ManagerId": "vvvvvd-4c4a-4e9a-a254-2dasdasd", "Name": "Test Client", "CompNum": null, "Emails": "testclient@test.com;", "Phones": "0500000000;", "APIResponse": [] } }
post/api/Clients/Create
POST /api/Clients/Create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "Id": 1,
  "UserId": "id_4059ba53",
  "ManagerId": "id_1b3efe3b",
  "Name": "John Doe",
  "CompNum": "sample_compnum",
  "Emails": "client@example.com",
  "Phones": "sample_phones",
  "Clients": null,
  "APIResponse": null
}
{

    "Status": "success",

    "Message": "",

    "ResponseObject": {

        "Id": 316258,

        "UserId": "xxxxx-4c4a-4e9a-a254-2222222",

        "ManagerId": "vvvvvd-4c4a-4e9a-a254-2dasdasd",

        "Name": "Test Client",

        "CompNum": null,

        "Emails": "testclient@test.com;",

        "Phones": "0500000000;",

        "APIResponse": []

    }

}

Assign Clients to Group

AssignClientsToGroup

post
Body
IdintegerRequiredExample: 1
UserIdstringOptionalExample: id_dfa8786a
ManagerIdstringOptionalExample: id_75975bb0
NamestringOptionalExample: John Doe
GroupClientsstringOptional
ClientsCounterintegerRequiredExample: 1
ClientsPhonesCounterintegerRequiredExample: 1
ClientsEmailsCounterintegerRequiredExample: 1
SignatureRoutinebooleanRequiredExample: true
APIResponsestringOptional
Responses
200

Success (No content returned)

No content

post/api/Groups/AssignClientsToGroup
POST /api/Groups/AssignClientsToGroup HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "Id": 1,
  "UserId": "id_dfa8786a",
  "ManagerId": "id_75975bb0",
  "Name": "John Doe",
  "GroupClients": null,
  "ClientsCounter": 1,
  "ClientsPhonesCounter": 1,
  "ClientsEmailsCounter": 1,
  "SignatureRoutine": true,
  "APIResponse": null
}

No content

Last updated