Create & Update Client Endpoints: CreateClientGroup

API endpoints for creating and patching clients and client groups

CreateClientGroup

This method creates a client group record.

See also Main Page → Fleet / Administration / Client Groups → Contact

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Client%20Groups/createClientGroup(https://api.catch-e.com/docs/#/Client%20Groups/createClientGroup)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on ClientGroups:Create

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.catch-e.com/fm/client-groups

Headers

Key	Format	Notes	Mandatory
Audit-User-Id	string	Pass a user_id here to create audit records with this user's details. This can only be done if the authenticated API user has Roles / Apis checked for the permission Audit:UserIdOverride	No

Body (JSON)

JSON Field	Format	Notes	Mandatory
clientgroupcode	string	Pass a unique Client Group Code	yes
name	string	Pass the Client Group name.	yes
address1	string	Pass the Client Group Address 1	no
address2	string	Pass the Client Group Address 2	no
area	string	Pass the Client Group Suburb	no
state	string	Pass the Client Group State	no
postcode	string	Pass the Client Group Postcode	no
contact	string	Pass the Client Group Contact	no
abn	string	Pass the Client Group ABN	no
acn	string	Pass the Client Group ACN	no
billing_email	string	Pass the Client Group email address	no
clientgroupidexternal	string	Pass the Client Group External Id	no

Input Fields (JSON)

{ "client_group_code": "CLGRP", "name": "clientGroupName", "address1": "addressOne", "address2": "addressTwo", "area": "suburb", "state": "VIC", "postcode": "3173", "contact": "contactName", "abn": "99 888 777 999", "acn": "888 777 999", "billing_email": "accounts@abcgroup.com.au", "client_group_id_external": "987654"}

Response Details

Validation Messages	Comments
201 Created

{ "client_group_id": "100015", "client_group_id_external": "987654", "client_group_code": "CLGRP", "name": "clientGroupName", "address1": "addressOne", "address2": "addressTwo", "area": "suburb", "state": "VIC", "postcode": "3173", "contact": "contactName", "abn": "99 888 777 999", "acn": "888 777 999", "billing_email": "accounts@abcgroup.com.au", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/client-groups/" }, "client_group": { "href": "https://api.test.catch-e.com/fm/client-groups/100015" } }}

| A successful response returns all fields in the new table record. |
| 422 Unprocessable Entity | | |

{ "validation_messages": { "name": { "stringLengthTooLong": "The input is more than 50 characters long" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

|"detail": "Forbidden"

| You do not have permissions for this request. |