CreateClientGroup

This method creates a client group record.

See also Fleet / Administration / Client Groups / Contact.

Supplementary SWAGGER documentation is available here: 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

client_group_code

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

client_group_id_external

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 Message

Comments

201 Created

A successful response returns all fields in the new client group record

422 Unprocessable Entity

Client Group name is limited to 50 characters

403 - Forbidden

You do not have permissions for this request

Successful Response Example

{ "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.catch-e.com/fm/client-groups/" }, "client_group": { "href": "https://api.catch-e.com/fm/client-groups/100015" } } }