clientGroup¶

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference¶

/rest/config/clientGroup

POST

This API adds a new Client Group and associated Client and User records.

acceptable request representations:

application/json

{    "name":"BigCo 1",
    "address1":"12 Allan Road",
    "address2":"Billington",
    "address3":"Bulford",
    "address4":"Baleshire",
    "postCode":"BB6 7GH",
    "telephone":"01395 278878",
    "fax":"01395 278878",
    "email":"enquiries@bigco.com",
    "userId":"alan@bigco.com",
    "password":"test1",
    "forename":"Alan",
    "surname":"Smith",}

available response representations:

200 - application/json

{
    "clientGroupId":"454",
    "userRef":"342"
}

See the Config API matrix for the full list of endpoints in this category.