Update custom dimension value

put

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/customdimensions/{definitionId}/values/{valueId}

Partially updates a value within a custom dimension definition. Only fields included in the request body are updated; omitted fields are left unchanged. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the custom dimension definition or the value is not found.

Path Params

organizationId

string

required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

definitionId

string

required

String. The ID of the custom dimension definition, as returned in the id field of the GET definition response.

valueId

string

required

String. The ID of the dimension value to update, as returned in the id field of the list values response.

Body Params

value

string

length ≤ 255

Display text of the dimension value. Must be non-empty and not whitespace-only.

sortOrder

integer | null

Sort position of the value within the list.

startDate

date-time | null

Date from which this value is active. ISO 8601 format.

endDate

date-time | null

Date until which this value is active. ISO 8601 format.

Responses

200OK — returns the updated custom dimension value

400Bad request

403Forbidden — organization not found or access denied

404Not found — custom dimension definition or value does not exist