patchClientsList

Overview

This method updates a list of existing clients in a single request. It is a partial update: for each client, only the fields you supply are updated, and all other fields keep their current values.

This method requires the Clients:Update permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Clients:Update'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/fm/clients https://api.{{environment}}.catch-e.com/fm/clients https://api.test.catch-e.com/fm/clients

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No
Time-Zone	string	(Optional) Clients will be processed in the specified timezone. Default `UTC`. Accepts a named time zone (e.g. 'Australia/Sydney') or an offset from UTC (e.g. '+10:00').	No

Input Fields (JSON)

Send an array of clients. Each client uses the same fields as patchClient; see that article for the full field list.

Key	Format	Notes	Mandatory
client_id	string	The Client Id of the client to update.	Yes
(any other client field)		Only the fields supplied are updated.	No

Example

[ { "client_id": "1234", "client_type": "fleet", "billing_interval": "monthly" }, { "client_id": "5678", "contact1_email": "[EMAIL]" } ]

Response Details

Success

200 - OK

Returns the updated clients. Each record in _embedded.fm_clients contains the same fields as getClient.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/clients?page=1" } }, "_embedded": { "fm_clients": [ { "_links": { "self": { "href": "https://api.catch-e.loc/fm/clients/1234" } }, "client_id": "1234", "client_code": "ACME", "name": "Acme Pty Ltd", "client_type": "fleet", "state": "NSW", "contact1_name": "[CONTACT-NAME]", "contact1_email": "[EMAIL]", "billing_interval": "monthly", "payment_method": "eft", "bank_bsb": "[BSB]", "bank_account_number": "[ACCOUNT-NUMBER]", "...": "..." } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

The example is shortened. Only a selection of fields is shown for each client.

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	One or more of the clients do not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }