Create & Update Client Endpoints: PatchClient — Permissions

API endpoints for creating and patching clients and client groups

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

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 'PATCH' for consuming this web service.

URL Examples

https://api.catch-e.com/fm/clients/{client_id}

Headers

KeyFormatNotesMandatory
Audit-User-IdstringPass 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:UserIdOverrideNo