Skip to main content
POST
/
v1
/
custom-properties
/
groups
/
{groupId}
/
values
Create custom property value
curl --request POST \
  --url https://api.light.inc/v1/custom-properties/groups/{groupId}/values \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "internalName": "<string>",
  "label": "<string>",
  "context": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "groupInternalName": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "internalName": "<string>",
  "label": "<string>",
  "context": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.light.inc/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

​
groupId
string<uuid>
required

Body

application/json;charset=UTF-8
​
internalName
string

Unique internal name for the custom property value.

​
label
string

Display label for the custom property value.

​
context
string | null

Optional context or description for the custom property value.

Response

default - application/json;charset=UTF-8

default response

List of values. Note that this will be a single value unless the group input type supports multiple values

​
id
string<uuid>

Unique identifier for the object

​
groupId
string<uuid>

ID of the custom property group

​
groupInternalName
string

Internal name of the custom property group

​
companyId
string<uuid>

ID of the company

​
internalName
string

Internal name of the custom property value

​
label
string

Label of the custom property value

​
context
string | null

Context/description of the custom property value

​
createdAt
string<date-time>

Timestamp when the custom property value was created

​
updatedAt
string<date-time>

Timestamp when the custom property value was last updated