Last Updated: 1/22/2020 12:11:02 AM
Create new group for customers
Request
HTTP Request
POST /SMPI/{version}/service/wfbss/api/groups
Parameters
Name |
Type |
Description |
Validation |
---|---|---|---|
Required Parameters |
|||
cids |
string |
A list of customer ID separated by comma. |
At least one customer ID must be specified, and no more than 10. |
name |
string |
Group name |
HTTP Request Example
Create a new group with given group name for specific customers: POST /SMPI/{version}/service/wfbss/api/groups?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3&name=Test_Group
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{ "customers": [ { "gid": 3, "id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C" }, { "gid": 5, "id": "5D9D17F9-E88D-4726-8132-02259569FEF7" } ] }
Name |
Type |
Description |
Length |
---|---|---|---|
customers[].id |
string |
Customer company ID |
GUID |
customers[].gid |
integer |
The ID of the newly created group. |