API Reference

Update custom dimension definition

put
https://stage-api.findity.com/api/v1/admin/organizations//customdimensions/

Partially updates an existing custom dimension definition identified by its ID. Only the fields present 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 is not found.

Path Params
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.

string
required

String. The ID of the custom dimension definition to update (32-character hex string), as returned in the id field of the GET response.

Body Params

Partial update — only the fields present in the request body are updated; omitted fields are left unchanged. To clear a nullable field, explicitly pass null. Omitting the field leaves it unchanged. At least one known property must be present. An empty body or a body with only unknown properties returns 400 INVALID_JSON_BODY or 400 NO_KNOWN_JSON_PROPERTIES respectively.

string
length ≤ 255

Display name of the custom dimension definition.

string
enum

The scope at which this dimension is applied. Use INACTIVE to set the dimension to inactive status.

Allowed:
string | null
enum

Where the preset value is defined.

Allowed:
string | null
enum

Input type for the dimension. LIST and LIST_SEARCHABLE are both accepted and stored as a fixed list; the GET response always returns LIST for both.

Allowed:
string | null

Caller-supplied identifier used to address this definition from an external system.

boolean | null

Whether the dimension value can be associated with a date interval.

string | null

ID of the recipient linked to this dimension.

boolean | null

Whether this dimension is used as a recipient filter.

boolean | null

Whether the available dimension values are hidden from users.

boolean | null

Whether this dimension is used in carbon footprint calculations.

boolean | null

Whether the dimension uses a deviating value on credit rows.

string | null
enum

Describes how the dimension is used within the system. VATDimension links the dimension to VAT code values in accounting.

Allowed:
boolean | null

When a preset is configured (presetLocation is not NONE), controls whether the user can override the preset value. Affects the computed visible field in the response.

boolean | null

When no preset is configured (presetLocation is NONE), controls whether the dimension is shown to users. Affects the computed visible field in the response.

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?