Delete custom property value

DELETE https://api.light.inc/v1/custom-properties/groups/{groupId}/values/{valueId}

Deletes a custom property value by ID

A soft delete with no in-use check: records that reference the value keep it, and the value keeps appearing on GET .../values (it disappears from the group's hydrated values). Repeating the call succeeds again. Answers 204 with no body. Requires the company-admin role.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

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

Path parameters

groupId string · uuidrequired
valueId string · uuidrequired

Response

This endpoint returns no content.

curl -X DELETE "https://api.light.inc/v1/custom-properties/groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/values/3c90c3cc-0d44-4b50-8888-8dd25736052a" \
  -H "Authorization: Basic YOUR_API_KEY"

const res = await fetch("https://api.light.inc/v1/custom-properties/groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/values/3c90c3cc-0d44-4b50-8888-8dd25736052a", {
  method: "DELETE",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
  },
});
const data = await res.json();

import os, requests

res = requests.delete(
    "https://api.light.inc/v1/custom-properties/groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/values/3c90c3cc-0d44-4b50-8888-8dd25736052a",
    headers={"Authorization": f"Basic {os.environ['LIGHT_API_KEY']}"},
)
data = res.json()