Skip to main content
PATCH
Update custom property value

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
valueId
string<uuid>
required

Body

application/json;charset=UTF-8
label
string | null

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