PatchClientGroup

This method allows you to edit 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/patchClientGroup

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:Update.

HTTP Method

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

URL Examples

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

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
name	string	Client Group name	No
address1	string	Client Group address line 1	No
address2	string	Client Group address line 2	No
area	string	Client Group suburb/area	No
state	string	Client Group state	No
postcode	string	Client Group postcode	No
contact	string	Client Group contact person	No
abn	string	Client Group Australian Business Number	No
acn	string	Client Group Australian Company Number	No
billing_email	string	Client Group email address for billing	No
client_group_id_external	string	Client Group external identifier	No

Input Fields (JSON)

{ "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
200 OK	A successful response returns all fields in the updated 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

A successful PATCH request returns the complete updated client group object:

{ "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" } } }

Error Response Examples

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" }

Client Group name is limited to 50 characters.

403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

Was this helpful?

Still need help? Ask the team