PUT client-app/…
Updates the details of a specific registered client app.
Resource URL
https://www.drillster.com/api/2/client-app/{client_id}
Parameters
| Field | Type | Description |
|---|---|---|
namerequired |
String | The name of the client application. Example value: Integration with LMS |
descriptionoptional |
String | A description of the client application. Example value: Provides an integration with LMS. |
redirectionEndpointrequired |
String | The OAuth redirection endpoint. See also the OAuth documentation. |
urloptional |
String | An optional URL for more information about the client app. Example value: https://www.example.com |
iconKeyoptional |
String | An optional key for an icon that may have just been uploaded. |
If a PUT request has no body (i.e. the body is empty), it is still mandatory to include a Content-Length header (i.e.
Content-Length: 0). Not all HTTP clients do this automatically. For more information, please see RFC 2616.
Response
The updated 2.0 ClientApp object.
Error responses
The following error situations are possible:
| ID | Response code | Description |
|---|---|---|
missing_client_id |
400 (Bad request) | No client ID given |
not_found |
404 (Not found) | Client application not found |
not_permitted |
403 (Forbidden) | Caller is not permitted to change client application |
invalid_name |
400 (Bad request) | Client application name is not valid |
invalid_redirection_uri |
400 (Bad request) | Given redirection URI is not valid |
invalid_application_url |
400 (Bad request) | Given application URL is not valid |
not_permitted |
403 (Forbidden) | Not permitted to change client app status |
invalid_status |
400 (Bad request) | Given status is not valid |