Create custom dimension value

post

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

Creates a new value for the given custom dimension definition. 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 or has been deleted. Returns 409 when a value with the same id already exists in the definition.

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 to add a value to, as returned in the id field of the GET definition response.

Body Params

string

required

length ≤ 255

Caller-supplied identifier for this value. Must be unique within the dimension definition.

value

string

required

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

201Created — returns the newly created custom dimension value

400Bad request

403Forbidden — organization not found or access denied

404Not found — custom dimension definition does not exist or has been deleted

409Conflict — a value with the same id already exists in this dimension definition