v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Update employee of the center with given catalog details

This API updates the existing employee profile with additional parameters for taking catalog information. If the catalog details are provided then the same will be updated and other values are set to default. If the sub-object catalog details are not passed in the request body, the default values will be set for catalog details ('ShowInCatalog' are set to false and ‘DisplayName' and 'Description’ would be set to empty)..

Note: For information on how to create an employee profile in a center, click here.

You must specify necessary details for the employee_id URI parameter in the API request. If you assign a new role ID to the employee, this API will update the employee's profile with the specified role ID and remove the existing role IDs. For more information on security roles, refer to the Retrieve the list of security roles in a center API.

Optionally, you can specify updated information for any of the request body parameters.

put/v1/employees/{employee_id}

Path parameters

employee_idstring required

Mandatory Unique 32-character identifier of the employee for whom you want to update profile details.

Query parameters

expandstring json

Additional json keys to display the key value pairs in the response json.

Request body

raw_bodystring json

Response

200