Value Lists / Entity

Create List

This endpoint allows you to create a List based on JSON input.

You will only be able to create a List after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.

HEADERS

ParameterValueDescription
Content-Typeapplication/jsonLanguage in which all request and response bodies are encoded
Accept*/*Any data of whatever mime type is accepted
X-Session-KeyAUTH_TOKENThis field must be completed with the token obtained at the authentication

REQUEST BODY

AttributeTypeDescription
databaseName (Required)StringName of the List at database level
description (Required)StringList name in Spanish
descriptionBRStringList name in Brasilian Portuguese
descriptionDEStringList name in German
descriptionDKStringList name in Dutch
descriptionENStringList name in English
descriptionFRStringList name in French
descriptionITStringList name in Italian
descriptionPTStringList name in Portuguese
descriptionRUStringList name in Russian
descripcionUSStringList name in American English

RESPONSE

Returns a JSON with information about the List just created.

AttributeType
databaseNameString
descriptionString
descriptionBRString
descriptionDEString
descriptionDKString
descriptionENString
descriptionFRString
descriptionITString
descriptionPTString
descriptionRUString
descripcionUSString

RESPONSE CODES

StatusDescription
200 OKShows if operation succeeded
400 Bad RequestShows when an invalid request or the requested service is not available
post/list

Request

  • Base URL: https://api.forcemanager.com/api/v4
  • URL: https://api.forcemanager.com/api/v4/list
  • Auth: API key in header X-Session-Key

Headers

Acceptstring

Request body

databaseNamestring
descriptionstring

Response

Create List

Changes

No recorded changes to this operation across all 1 revision of this API.