Value Lists / Entity
Update List
This endpoint allows you to update a specific List's information. If the specified List does not exist, the response will be a "bad request".
You will only receive the Resource's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST BODY
| Attribute | Type | Description |
|---|---|---|
| databaseName | String | Name of the List at database level |
| description | String | List name in Spanish |
| descriptionBR | String | List name in Brasilian Portuguese |
| descriptionDE | String | List name in German |
| descriptionDK | String | List name in Dutch |
| descriptionEN | String | List name in English |
| descriptionFR | String | List name in French |
| descriptionIT | String | List name in Italian |
| descriptionPT | String | List name in Portuguese |
| descriptionRU | String | List name in Russian |
| descripcionUS | String | List name in American English |
RESPONSE
Returns a JSON with information about the List just updated.
| Attribute | Type |
|---|---|
| databaseName | String |
| description | String |
| descriptionBR | String |
| descriptionDE | String |
| descriptionDK | String |
| descriptionEN | String |
| descriptionFR | String |
| descriptionIT | String |
| descriptionPT | String |
| descriptionRU | String |
| descripcionUS | String |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
put/list/VALUE
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/list/VALUE
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update List
Changes
No recorded changes to this operation across all 1 revision of this API.