Details

Update a client.

An account token or server token may be used to run this endpoint.

Parameters

path

id (required): The ID of the client.

body

name (optional): The name of the client.
description (optional): The description of the client.

Responses

200

No content returned, only the status code. See the REST API Standard Responses page.

400

Client Invalid: The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the ID given for a client is invalid.
No Query String Allowed: The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.
Body Parameters Missing: The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.”

404

Client Not Found: This error means that a client with the given ID was not found. This is distinct from an invalid client ID being specified; this means that the client ID once existed, but no longer does.

Examples

HTTP

PUT https://ioe.droplit.io/api/clients/CLIENT-ID HTTP/1.1
authorization: TOKEN
content-type: application/json
{
    "name": "CLIENT-NAME",
    "description": "CLIENT-DESCRIPTION"
}

Droplit Console

droplit client update CLIENT-ID PROPERTY-NAME PROPERTY-VALUE

Droplit SDK

droplit.clients.update("CLIENT-ID", { "PROPERTY-NAME" : "PROPERTY-VALUE" });