Skip to content

Update a client

Request to update existing client:

PUT /api/v2/clients/<client-id>.json

HTTP body should contain JSON formatted profile of client to update.

For example:

{
    "client": {
        "name": "New Client Name"
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
200 OK

Client has been successfully updated.

A response contains a JSON formatted client's data after update.
403 Forbidden The request cannot be completed because API user has no permission to edit groups
400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{"error": "InvalidRecord","description": "Record Validation errors","details": ["name": "Client with such name exists already"]}