Skip to main content

Add element to a lookup list

POST 
/v1/lookup-lists/:lookupListId/elements

Adds a new element to an existing lookup list. An element is a field value and comment (helpful description that does not affect the lookup functionally).

Request​

Path Parameters

    lookupListId stringrequired

    GUID of the lookup list.

    Example: 7c985e09-3db6-5dc6-ae33-58403493e13f

Body

required
    value stringrequired

    Possible values: non-empty and <= 80 characters

    A single field value.

    comment string

    Possible values: <= 200 characters

    Optional. A place to add a note or additional details about the value. For example, if the value is an IP address, the comment can identify the server.

    expirationDate int64

    Optional. The expiration date and time of the lookup list as UNIX epoch milliseconds. When this parameter is left empty, the lookup list does not expire.

Responses​

successful operation

Response Headers
    Schema
      id int32

      ID of the element in the Lookup list.

      value string

      Possible values: non-empty and <= 80 characters

      A single field value. You should ensure that the lookup list contains a list of values all mapped to the same field.

      comment string

      Possible values: <= 200 characters

      Optional. A place to add a note or additional details about the value. For example, if the value is an IP address, the comment can identify the server.

      expirationDate int64

      Optional. The expiration date and time of the lookup list as UNIX epoch milliseconds. When this parameter is left empty, the lookup list does not expire.

    Loading...