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
{
"Name":"Testing Group"
}Body
IdintegerRequiredExample:
1UserIdstringOptionalExample:
id_dfa8786aManagerIdstringOptionalExample:
id_75975bb0NamestringOptionalExample:
John DoeGroupClientsstringOptional
ClientsCounterintegerRequiredExample:
1ClientsPhonesCounterintegerRequiredExample:
1ClientsEmailsCounterintegerRequiredExample:
1SignatureRoutinebooleanRequiredExample:
trueAPIResponsestringOptional
Responses
200
Success (No content returned)
No content
400
Bad Request
500
Internal Server Error
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
Body
IdintegerRequiredExample:
1UserIdstringOptionalExample:
id_4059ba53ManagerIdstringOptionalExample:
id_1b3efe3bNamestringOptionalExample:
John DoeCompNumstringOptionalExample:
sample_compnumEmailsstringOptionalExample:
client@example.comPhonesstringOptionalExample:
sample_phonesClientsstringOptional
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": [] } }400
Bad Request
500
Internal Server Error
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
Body
IdintegerRequiredExample:
1UserIdstringOptionalExample:
id_dfa8786aManagerIdstringOptionalExample:
id_75975bb0NamestringOptionalExample:
John DoeGroupClientsstringOptional
ClientsCounterintegerRequiredExample:
1ClientsPhonesCounterintegerRequiredExample:
1ClientsEmailsCounterintegerRequiredExample:
1SignatureRoutinebooleanRequiredExample:
trueAPIResponsestringOptional
Responses
200
Success (No content returned)
No content
400
Bad Request
500
Internal Server Error
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