POST Create Group API

This API will create a group of multiple recipients.

Request Attributes

API Content Type: JSON

Head

ATTRIBUTE DESCRIPTION
x-access-token
string
mandatory
Token generated from the authentication api.
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TU5NzgyMDA1N30.9eO_xh eyJEYXRhIjp7InVzZXJpZCI6IjY3NCIsImVtYWlsIjoiYWFhYWFhYWFhYWjuunGJQ YmwuY29tIiwia2V5IjoidGVzdGluZ0tleSJ9LCJpYXQiOjE1OTc3NDA4NTpj6gc8dM csIFhY7n1mV4cUBxa2P3ICI6M2VyWq19OzuHAefeTEj

body

ATTRIBUTE DESCRIPTION
user_id
string(32)
mandatory
UserId given in companyprofile page.
Example: USR1HINU6OROEZZP1YS1592227436777
groupname
string(32)
mandatory
Name of the group.
Example: Students
array of object
mandatory
This parameter is an array of object and should contain the details of recipients i.e. Name, Email and Mobile.
Attribute Description
Name
string(32)
mandatory
Name of the recipient.
Example: Sachin
Email
string(32)
mandatory
Email of the recipient.
Example: sachin@gmail.com
Mobile
string(10)
optional
Mobile Number of the recipient.
Example: 9874563210

Response Attributes

API Content Type: JSON

body

ATTRIBUTE DESCRIPTION
statuscode
string(3)
This is the status code corresponding to a particular message and is returned to the user. The different status codes corresponding to this API are mentioned below
Example: 200
status
boolean
This parameter indicates the status of API call.
Possible Values: true or false
object
This parameter gives the information about the result of the API response.
Attribute Description
groupid
string(32)
Unique Id of the group.
Example: FJKBDSHVBNVNDJCVNMF
message
string(100)
This parameter is the result message which contains information about the result.
Example: group saved successfully.

Response Codes and Messages

statuscode status Description
200
true
 Success
401
false
 Your Session has expired
409
false
 Conflict has occured
422
false
 Invalid parameter
500
false
 System error
https://console.konsign.com/api/group/addgroup
https://console.konsign.com/api/group/addgroup
REQUEST RESPONSE 
var https = require('follow-redirects').https;
											var fs = require('fs');
											
											var options = {
											  'method': 'POST',
											  'hostname': 'console.konsign.com',
											  'path': '/group/api/addgroup',
											  'headers': {
												'Authorization': 'Bearer YOUR_AUTH_TOKEN',
												'Content-Type': 'application/json'
											  },
											  'maxRedirects': 20
											};
											
											var req = https.request(options, function (res) {
											  var chunks = [];
											
											  res.on("data", function (chunk) {
												chunks.push(chunk);
											  });
											
											  res.on("end", function (chunk) {
												var body = Buffer.concat(chunks);
												console.log(body.toString());
											  });
											
											  res.on("error", function (error) {
												console.error(error);
											  });
											});
											
											var postData = JSON.stringify({
											  "user_id": "YOUR_USER_ID",
											  "groupname": "GROUP_NAME",
											  "recipients": [
												{
												  "Name": "RECIPIENT_1_NAME",
												  "Email": "RECIPIENT_1_EMAIL"
												},
												{
												  "Name": "RECIPIENT_2_NAME",
												  "Email": "RECIPIENT_2_EMAIL"
												},
												{
												  "Name": "RECIPIENT_3_NAME",
												  "Email": "RECIPIENT_3_EMAIL"
												}
											  ]
											});
											
											req.write(postData);
											
											req.end();
										
									
var client = new RestClient("https://console.konsign.com/group/api/addgroup");
											client.Timeout = -1;
											var request = new RestRequest(Method.POST);
											request.AddHeader("Authorization", "Bearer YOUR_AUTH_TOKEN");
											request.AddHeader("Content-Type", "application/json");
											var body = @"{
											" + "\n" +
											@"    ""user_id"": ""YOUR_USER_ID"",
											" + "\n" +
											@"    ""groupname"": ""GROUP_NAME"",
											" + "\n" +
											@"    ""recipients"": [
											" + "\n" +
											@"        {
											" + "\n" +
											@"            ""Name"": ""RECIPIENT_1_NAME"",
											" + "\n" +
											@"            ""Email"": ""RECIPIENT_1_EMAIL""
											" + "\n" +
											@"        },
											" + "\n" +
											@"        {
											" + "\n" +
											@"            ""Name"": ""RECIPIENT_2_NAME"",
											" + "\n" +
											@"            ""Email"": ""RECIPIENT_2_EMAIL""
											" + "\n" +
											@"        },
											" + "\n" +
											@"        {
											" + "\n" +
											@"            ""Name"": ""RECIPIENT_3_NAME"",
											" + "\n" +
											@"            ""Email"": ""RECIPIENT_3_EMAIL""
											" + "\n" +
											@"        }
											" + "\n" +
											@"    ]
											" + "\n" +
											@"}";
											request.AddParameter("application/json", body,  ParameterType.RequestBody);
											IRestResponse response = client.Execute(request);
											Console.WriteLine(response.Content);
										
									
										{
											"head": {
												"responseTimestamp": "1526969112101",
												"version": "v1",
												"clientId": "C11",
												"signature": "TXBw50YPUKIgJd8gR8RpZuOMZ+csvCT7i0/YXmG//J8+BpFdY5goPBiLAkCzKlCkOvAQip/Op5aD6Vs+cNUTjFmC55JBxvp7WunZ45Ke2q0="
											},
											"body": {
												"resultInfo": {
													"resultStatus": "S",
													"resultCode": "0000",
													"resultMsg": "Success"
												},
												"txnToken": "fe795335ed3049c78a57271075f2199e1526969112097",
												"isPromoCodeValid": false,
												"authenticated": false
											}
										}