v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Extra Value (Custom Field)

Create Extra Value by Entity Type and ID

Creates an extra value (custom field) by Entity Type and ID.

post/v3/{entityType}/{entityId}/extras

Path parameters

entityTypestring required

The Back Office entity type.

entityIdinteger required

The unique identifier for the Back Office entity.

Headers

FrontOfficeTenantIdinteger required

An integer identifier for the tenant that the request is being made for.

RequestIdstring uuid required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

RequestOriginstring required

The string source name (such as application or function name) that indicates the origin of the request.

ExternalIdSource'BOLD' required

Example:BOLD

The external ID source that determines which external reference source is used to perform an external ID lookup.

RequestUserExternalIdstring

Example:ABC123

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Request body

customSetupOptionIdinteger

The unique identifier for the Setup Option.

extraValueOptionValuestring nullable

The value set on the ExtraValue table that corresponds to the provided customSetupOptionId.

Response

Successfully created extra value.