> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Add components to a component reference list > Adds the components in `component_ids` to the named `COMPONENT_REFERENCE_LIST` setting and captures them in the setting value, after the components already selected. Every stored entry is kept as it is, so a caller that sees only part of the selection - one campaign, one page of candidates - adds to it without reading it first and without dropping what it cannot see. Only the added components are checked for eligibility; naming a component that is already selected leaves the stored value unchanged, though the setting is still saved and a campaign version is still written. Returns the setting in the same shape as `GET` and `PUT` on the setting itself. ## OpenAPI ````yaml /api-reference/management.json post /v1/components/{component_id}/settings/component-reference-list/{setting_name}/add openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. ## Updating a resource `PUT` merges. A field you omit from the body is left at its stored value, so you do not need to read a resource and send it back whole in order to change one field. This is a deliberate departure from the HTTP convention that `PUT` replaces, and it holds across this API. Two qualifications, both visible on each operation's own request schema: - Some operations mark fields `required` in their request schema. Those must be sent on every request, whether or not you are changing them. - A field that holds a list or a map is replaced, not merged, when you supply it. Sending one entry of a collection stores that entry and drops the rest, so to change one member of a collection you must send the collection's other members alongside it. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Batch Jobs (Legacy) - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Domains - name: Email - name: Erasure - name: Event Streams - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: SFTP Servers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v1/components/{component_id}/settings/component-reference-list/{setting_name}/add: post: tags: - Components summary: Add components to a component reference list description: >- Adds the components in `component_ids` to the named `COMPONENT_REFERENCE_LIST` setting and captures them in the setting value, after the components already selected. Every stored entry is kept as it is, so a caller that sees only part of the selection - one campaign, one page of candidates - adds to it without reading it first and without dropping what it cannot see. Only the added components are checked for eligibility; naming a component that is already selected leaves the stored value unchanged, though the setting is still saved and a campaign version is still written. Returns the setting in the same shape as `GET` and `PUT` on the setting itself. parameters: - in: path name: component_id required: true schema: type: string - in: path name: setting_name required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id variant: variant schema: $ref: '#/components/schemas/ComponentReferenceListAddRequest' responses: '200': content: application/json: schema: $ref: >- #/components/schemas/CampaignComponentComponentReferenceVariableResponse description: >- The setting after the components were added, in the same shape `GET` and `PUT` return. '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_concurrent_client_change_update: $ref: >- #/components/examples/campaign_concurrent_client_change_update campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' component_id_missing: $ref: '#/components/examples/component_id_missing' component_id_not_accessible: $ref: '#/components/examples/component_id_not_accessible' component_ids_missing: $ref: '#/components/examples/component_ids_missing' component_not_found: $ref: '#/components/examples/component_not_found' component_not_selectable: $ref: '#/components/examples/component_not_selectable' component_operation_parameter_invalid: $ref: '#/components/examples/component_operation_parameter_invalid' component_operation_path_malformed: $ref: '#/components/examples/component_operation_path_malformed' component_operation_path_missing: $ref: '#/components/examples/component_operation_path_missing' component_operation_schema_invalid: $ref: '#/components/examples/component_operation_schema_invalid' component_operation_schema_too_large: $ref: '#/components/examples/component_operation_schema_too_large' component_owner_not_supported: $ref: '#/components/examples/component_owner_not_supported' component_state_not_supported: $ref: '#/components/examples/component_state_not_supported' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' default_key_not_allowed: $ref: '#/components/examples/default_key_not_allowed' display_name_has_illegal_character: $ref: '#/components/examples/display_name_has_illegal_character' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_not_found: $ref: '#/components/examples/external_element_not_found' external_element_type_not_supported: $ref: '#/components/examples/external_element_type_not_supported' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_external_element_filter: $ref: '#/components/examples/invalid_external_element_filter' invalid_incoming_url: $ref: '#/components/examples/invalid_incoming_url' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_setting_filter: $ref: '#/components/examples/invalid_setting_filter' invalid_translatable_value: $ref: '#/components/examples/invalid_translatable_value' invalid_uri_in_json: $ref: '#/components/examples/invalid_uri_in_json' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' multiple_components_installed_into_single_socket: $ref: >- #/components/examples/multiple_components_installed_into_single_socket non_translatable_variable_can_not_be_updated: $ref: >- #/components/examples/non_translatable_variable_can_not_be_updated rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' reward_supplier_id_list_invalid_configuration: $ref: >- #/components/examples/reward_supplier_id_list_invalid_configuration setting_batch_update_missing_request: $ref: '#/components/examples/setting_batch_update_missing_request' setting_display_name_length_out_of_range: $ref: >- #/components/examples/setting_display_name_length_out_of_range setting_filter_component_facet_name_missing: $ref: >- #/components/examples/setting_filter_component_facet_name_missing setting_filter_component_facet_value_missing: $ref: >- #/components/examples/setting_filter_component_facet_value_missing setting_filter_component_type_missing: $ref: '#/components/examples/setting_filter_component_type_missing' setting_filter_expression_evaluation_failed: $ref: >- #/components/examples/setting_filter_expression_evaluation_failed setting_filter_invalid_component_facet: $ref: '#/components/examples/setting_filter_invalid_component_facet' setting_filter_invalid_component_type: $ref: '#/components/examples/setting_filter_invalid_component_type' setting_name_duplicated: $ref: '#/components/examples/setting_name_duplicated' setting_name_length_out_of_range: $ref: '#/components/examples/setting_name_length_out_of_range' setting_name_missing: $ref: '#/components/examples/setting_name_missing' setting_name_reserved: $ref: '#/components/examples/setting_name_reserved' setting_not_found: $ref: '#/components/examples/setting_not_found' setting_validation_exception: $ref: '#/components/examples/setting_validation_exception' settings_build_failed: $ref: '#/components/examples/settings_build_failed' socket_missing_required_parameter: $ref: '#/components/examples/socket_missing_required_parameter' socket_not_found: $ref: '#/components/examples/socket_not_found' tag_length_out_of_range: $ref: '#/components/examples/tag_length_out_of_range' unavailable_referenced_variable: $ref: '#/components/examples/unavailable_referenced_variable' unexpected_setting_type: $ref: '#/components/examples/unexpected_setting_type' unknown_source_clients: $ref: '#/components/examples/unknown_source_clients' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' variable_batch_update_has_duplicated_variable_name: $ref: >- #/components/examples/variable_batch_update_has_duplicated_variable_name variable_batch_update_invalid_type: $ref: '#/components/examples/variable_batch_update_invalid_type' variable_batch_update_missing_type: $ref: '#/components/examples/variable_batch_update_missing_type' variable_circular_reference: $ref: '#/components/examples/variable_circular_reference' variable_description_length_out_of_range: $ref: >- #/components/examples/variable_description_length_out_of_range variable_value_invalid_type: $ref: '#/components/examples/variable_value_invalid_type' variable_value_key_length_out_of_range: $ref: '#/components/examples/variable_value_key_length_out_of_range' schema: $ref: '#/components/schemas/RestExceptionResponse' description: >- `component_ids_missing` when `component_ids` is omitted, `component_id_missing` when one of its entries is blank. `component_not_selectable` when a component being added is outside the setting's boundary, does not carry the required component types, or is excluded by one of the setting's selectable filters - call selectable-components to see what is eligible. `unexpected_setting_type` when the named setting is not a `COMPONENT_REFERENCE_LIST` setting. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: ComponentReferenceListAddRequest: properties: component_ids: description: >- The components to add to this reference. Every component already selected stays selected, and naming one that is already selected changes nothing. Every added id must be eligible for this reference: inside the setting's boundary, carrying the required component types, and not excluded by a selectable filter. items: description: >- The components to add to this reference. Every component already selected stays selected, and naming one that is already selected changes nothing. Every added id must be eligible for this reference: inside the setting's boundary, carrying the required component types, and not excluded by a selectable filter. type: string type: array variant: description: >- The setting value variant the selection is added to. Defaults to `default`. type: string required: - component_ids type: object CampaignComponentComponentReferenceVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: boundary: $ref: '#/components/schemas/ComponentReferenceBoundaryResponse' component_type: description: Component type that can be selected by this variable. type: string lookup_strategy: $ref: '#/components/schemas/ComponentReferenceLookupStrategyResponse' selectable_filters: description: Filters that narrow the components available for selection. items: $ref: '#/components/schemas/SettingFilterResponse' type: array source: description: >- Where this setting takes its value from. LOCAL uses the `values` stored on this component. INHERITED uses the same-named setting of the nearest ancestor component that is not itself INHERITED. PARAMETER uses the same-named parameter of the socket this component is installed into. For an INHERITED setting, `values` shows what is stored on this component, not the value in effect; the built setting reports that. enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - COMPONENT_REFERENCE - COMPONENT_REFERENCE_LIST type: string unmatched_description: $ref: >- #/components/schemas/UnmatchedDescriptionInCampaignComponentComponentReferenceVariableResponse values: additionalProperties: true description: >- Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. properties: default: $ref: >- #/components/schemas/DefaultInComponentSettingVariableValuesOpenApiDocumentation en: $ref: >- #/components/schemas/EnInComponentSettingVariableValuesOpenApiDocumentation type: object type: object description: >- Stored campaign component component reference variable definition. Fields `description` and `unmatched_description` are unevaluated and appear in buildtime-evaluatable form. required: - boundary - component_type - description - display_name - lookup_strategy - name - priority - selectable_filters - source - tags - type - unmatched_description - values type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object CampaignComponentSettingResponseBase: properties: description: $ref: '#/components/schemas/DescriptionInCampaignComponentSettingResponse' display_name: type: string name: type: string priority: $ref: '#/components/schemas/DeweyDecimal' tags: items: type: string type: array uniqueItems: true type: enum: - ADMIN_ICON - AUDIENCE_ID - AUDIENCE_ID_LIST - BOOLEAN - BROWSER_SIDE_JAVASCRIPT - CLIENT_DOMAIN_ID_LIST - CLIENT_KEY - CLIENT_KEY_FLOW - COLOR - COMPONENT_ID - COMPONENT_REFERENCE - COMPONENT_REFERENCE_LIST - COMPONENT_SETTING_LOOKUP - CSS - DATE_TIME - DELAY - DELAY_LIST - ENUM - ENUM_LIST - EXTOLE_CLIENT_KEY - FONT - GLOB_COMPONENT_PATH - HTML - IMAGE - INTEGER - INTEGER_LIST - JSON - MULTI_SOCKET - PARTNER_ENUM - PARTNER_ENUM_LIST - PERSON_KEY_NAME - REWARD_SUPPLIER_ID - REWARD_SUPPLIER_ID_LIST - SFTP_DIRECTORY - SOCKET - STRING - STRING_LIST - STRING_MAP - TRIGGER_CONFIGURATION - URL - WEBHOOK_ID type: string type: object ComponentReferenceBoundaryResponse: description: Boundary that limits where selectable components are resolved from. discriminator: mapping: ANCESTOR_TYPE: '#/components/schemas/AncestorTypeComponentReferenceBoundaryResponse' PATH: '#/components/schemas/PathComponentReferenceBoundaryResponse' propertyName: type oneOf: - $ref: '#/components/schemas/AncestorTypeComponentReferenceBoundaryResponse' - $ref: '#/components/schemas/PathComponentReferenceBoundaryResponse' ComponentReferenceLookupStrategyResponse: description: Lookup strategy used to match selectable components. discriminator: mapping: CAMPAIGN_PATH: >- #/components/schemas/CampaignPathComponentReferenceLookupStrategyResponse EXPRESSION: >- #/components/schemas/ExpressionComponentReferenceLookupStrategyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/CampaignPathComponentReferenceLookupStrategyResponse - $ref: >- #/components/schemas/ExpressionComponentReferenceLookupStrategyResponse SettingFilterResponse: discriminator: mapping: COMPONENT_TYPE: '#/components/schemas/ComponentTypeSettingFilterResponse' EXPRESSION: '#/components/schemas/ExpressionSettingFilterResponse' FACET: '#/components/schemas/ComponentFacetSettingFilterResponse' propertyName: type oneOf: - $ref: '#/components/schemas/ComponentTypeSettingFilterResponse' - $ref: '#/components/schemas/ExpressionSettingFilterResponse' - $ref: '#/components/schemas/ComponentFacetSettingFilterResponse' UnmatchedDescriptionInCampaignComponentComponentReferenceVariableResponse: description: >- Description shown when a saved reference no longer matches a selectable component. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Literal unmatched description title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{unmatchedDescription}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('unmatchedDescription');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DefaultInComponentSettingVariableValuesOpenApiDocumentation: description: >- Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. oneOf: - description: Literal default title: Static Value type: object - description: >- Handlebars expression with [VariableBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts). example: handlebars@buildtime:{{default}} externalDocs: description: VariableBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [VariableBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('default');} externalDocs: description: VariableBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EarnedRewardEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/EarnedRewardEvaluationContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [EmailV2ActionContentContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContentContext.d.ts), [EmailV2ActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContext.d.ts), [EmailV2ActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionResponseContext.d.ts), [ExpireRewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expire/reward/ExpireRewardActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{default}} pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EarnedRewardEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/EarnedRewardEvaluationContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [EmailV2ActionContentContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContentContext.d.ts), [EmailV2ActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContext.d.ts), [EmailV2ActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionResponseContext.d.ts), [ExpireRewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expire/reward/ExpireRewardActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('default');} pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnInComponentSettingVariableValuesOpenApiDocumentation: description: >- Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. oneOf: - description: Literal en title: Static Value type: object - description: >- Handlebars expression with [VariableBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts). example: handlebars@buildtime:{{en}} externalDocs: description: VariableBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [VariableBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('en');} externalDocs: description: VariableBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EarnedRewardEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/EarnedRewardEvaluationContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [EmailV2ActionContentContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContentContext.d.ts), [EmailV2ActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContext.d.ts), [EmailV2ActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionResponseContext.d.ts), [ExpireRewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expire/reward/ExpireRewardActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{en}} pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EarnedRewardEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/EarnedRewardEvaluationContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [EmailV2ActionContentContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContentContext.d.ts), [EmailV2ActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionContext.d.ts), [EmailV2ActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/v2/EmailV2ActionResponseContext.d.ts), [ExpireRewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expire/reward/ExpireRewardActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('en');} pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DescriptionInCampaignComponentSettingResponse: description: >- The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Literal description title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DeweyDecimal: example: '10' type: string AncestorTypeComponentReferenceBoundaryResponse: allOf: - $ref: '#/components/schemas/ComponentReferenceBoundaryResponseBase' - properties: ancestor_type: description: >- Ancestor component type that defines the selectable component boundary. type: string type: enum: - ANCESTOR_TYPE type: string type: object description: >- Boundary that resolves selectable components within the nearest matching ancestor component type. required: - ancestor_type - type title: ANCESTOR_TYPE type: object PathComponentReferenceBoundaryResponse: allOf: - $ref: '#/components/schemas/ComponentReferenceBoundaryResponseBase' - properties: path: $ref: >- #/components/schemas/PathInPathComponentReferenceBoundaryResponse type: enum: - PATH type: string type: object description: >- Boundary that resolves selectable components within an evaluated component path. required: - path - type title: PATH type: object CampaignPathComponentReferenceLookupStrategyResponse: allOf: - $ref: '#/components/schemas/ComponentReferenceLookupStrategyResponseBase' - properties: type: enum: - CAMPAIGN_PATH type: string type: object description: >- Default lookup strategy: matches candidates using their in-campaign path. required: - type title: CAMPAIGN_PATH type: object ExpressionComponentReferenceLookupStrategyResponse: allOf: - $ref: '#/components/schemas/ComponentReferenceLookupStrategyResponseBase' - properties: keys: description: Keys used to match selectable components. items: $ref: '#/components/schemas/ComponentReferenceLookupKeyResponse' type: array type: enum: - EXPRESSION type: string type: object description: >- Lookup strategy that matches candidates using declared keys, each evaluated per candidate component. required: - keys - type title: EXPRESSION type: object ComponentTypeSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: component_type: type: string type: enum: - COMPONENT_TYPE type: string type: object required: - component_type - type title: COMPONENT_TYPE type: object ExpressionSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: expression: $ref: '#/components/schemas/ExpressionInExpressionSettingFilterResponse' type: enum: - EXPRESSION type: string type: object description: >- Stored expression setting filter definition. Field `expression` is unevaluated and appears in buildtime-evaluatable form. required: - expression - type title: EXPRESSION type: object ComponentFacetSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: name: type: string type: enum: - FACET type: string value: type: string type: object required: - name - type - value title: FACET type: object ComponentReferenceBoundaryResponseBase: properties: type: description: >- How the boundary containing selectable components is derived. ANCESTOR_TYPE takes the nearest ancestor of the configured component type. PATH takes the component matched by a configured absolute path. enum: - ANCESTOR_TYPE - PATH type: string type: object PathInPathComponentReferenceBoundaryResponse: description: >- Path expression, evaluated at build or install time, that defines the selectable component boundary. Buildtime expressions use [ComponentReferenceBoundaryPathContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts). externalDocs: description: ComponentReferenceBoundaryPathContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal path title: Static Value - description: >- Handlebars expression with [ComponentReferenceBoundaryPathContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts). example: handlebars@buildtime:{{path}} externalDocs: description: ComponentReferenceBoundaryPathContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [ComponentReferenceBoundaryPathContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('path');} externalDocs: description: ComponentReferenceBoundaryPathContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceBoundaryPathContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceLookupStrategyResponseBase: properties: type: description: >- How candidate components are matched against a saved reference. CAMPAIGN_PATH (the default) matches candidates by their in-campaign path. EXPRESSION matches candidates using declared keys, each evaluated per candidate. enum: - CAMPAIGN_PATH - EXPRESSION type: string type: object ComponentReferenceLookupKeyResponse: description: >- Configured component attribute, evaluated per candidate component, used for reference matching. properties: expression: $ref: >- #/components/schemas/ExpressionInExpressionComponentReferenceLookupStrategyResponse match: description: >- How a configured component reference key is matched. Values are compared as whole values, never as substrings. EQUALS requires a component's values for the key to be exactly the declared set, compared case-sensitively. EQUALS_IGNORE_CASE applies the same set equality ignoring case. CONTAINS requires a component's values to include every declared value, ignoring case, and allows the component to carry further values beyond those declared. enum: - CONTAINS - EQUALS - EQUALS_IGNORE_CASE type: string name: description: Name of this key, unique among the lookup strategy's keys. type: string type: description: >- The declared setting type of this key's evaluated value, driving how it is compared. Any setting type is accepted and compared as evaluated, except STRING and COMPONENT_ID, which collapse a list-valued result to its first element before comparing. enum: - ADMIN_ICON - AUDIENCE_ID - AUDIENCE_ID_LIST - BOOLEAN - BROWSER_SIDE_JAVASCRIPT - CLIENT_DOMAIN_ID_LIST - CLIENT_KEY - CLIENT_KEY_FLOW - COLOR - COMPONENT_ID - COMPONENT_REFERENCE - COMPONENT_REFERENCE_LIST - COMPONENT_SETTING_LOOKUP - CSS - DATE_TIME - DELAY - DELAY_LIST - ENUM - ENUM_LIST - EXTOLE_CLIENT_KEY - FONT - GLOB_COMPONENT_PATH - HTML - IMAGE - INTEGER - INTEGER_LIST - JSON - MULTI_SOCKET - PARTNER_ENUM - PARTNER_ENUM_LIST - PERSON_KEY_NAME - REWARD_SUPPLIER_ID - REWARD_SUPPLIER_ID_LIST - SFTP_DIRECTORY - SOCKET - STRING - STRING_LIST - STRING_MAP - TRIGGER_CONFIGURATION - URL - WEBHOOK_ID type: string required: - expression - match - name - type type: object SettingFilterResponseBase: properties: type: enum: - COMPONENT_TYPE - EXPRESSION - FACET type: string type: object ExpressionInExpressionSettingFilterResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [SettingFilterBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts). externalDocs: description: SettingFilterBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts oneOf: - description: Literal expression title: Static Value type: boolean - description: >- Handlebars expression with [SettingFilterBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: SettingFilterBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [SettingFilterBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: SettingFilterBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ExpressionInExpressionComponentReferenceLookupStrategyResponse: description: >- Expression evaluated per candidate component to produce this key's value. Runtime expressions use [ComponentReferenceLookupStrategyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts). externalDocs: description: ComponentReferenceLookupStrategyContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts oneOf: - description: Literal expression title: Static Value type: object - description: >- Handlebars expression with [ComponentReferenceLookupStrategyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ComponentReferenceLookupStrategyContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ComponentReferenceLookupStrategyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ComponentReferenceLookupStrategyContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ComponentReferenceLookupStrategyContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_build_failed: summary: campaign_build_failed value: code: campaign_build_failed http_status_code: 400 message: Campaign build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_not_found: summary: campaign_component_not_found value: code: campaign_component_not_found http_status_code: 400 message: Campaign Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_client_change_update: summary: campaign_concurrent_client_change_update value: code: campaign_concurrent_client_change_update http_status_code: 400 message: >- Could not perform the operation. A client wide configuration change is rebuilding this campaign. Retry once it completes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: >- Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_stale_version: summary: campaign_stale_version value: code: campaign_stale_version http_status_code: 400 message: You can only modify the latest version of the campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_id_missing: summary: component_id_missing value: code: component_id_missing http_status_code: 400 message: A component id is required and must not be blank parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_id_not_accessible: summary: component_id_not_accessible value: code: component_id_not_accessible http_status_code: 400 message: >- Component setting points to a non-existing or not accessible component id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_ids_missing: summary: component_ids_missing value: code: component_ids_missing http_status_code: 400 message: component_ids is required, send an empty list to clear the selection parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_not_found: summary: component_not_found value: code: component_not_found http_status_code: 400 message: Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_not_selectable: summary: component_not_selectable value: code: component_not_selectable http_status_code: 400 message: Component is not selectable for the component reference setting parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_parameter_invalid: summary: component_operation_parameter_invalid value: code: component_operation_parameter_invalid http_status_code: 400 message: Component operation parameter is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_malformed: summary: component_operation_path_malformed value: code: component_operation_path_malformed http_status_code: 400 message: Component operation path is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_missing: summary: component_operation_path_missing value: code: component_operation_path_missing http_status_code: 400 message: Component operation path is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_invalid: summary: component_operation_schema_invalid value: code: component_operation_schema_invalid http_status_code: 400 message: >- Component operation schema is not a valid JSON Schema draft 2020-12 document parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_too_large: summary: component_operation_schema_too_large value: code: component_operation_schema_too_large http_status_code: 400 message: Component operation schema serialized length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_owner_not_supported: summary: component_owner_not_supported value: code: component_owner_not_supported http_status_code: 400 message: Component owner not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_state_not_supported: summary: component_state_not_supported value: code: component_state_not_supported http_status_code: 400 message: Component state not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_state_misconfiguration: summary: controller_state_misconfiguration value: code: controller_state_misconfiguration http_status_code: 400 message: A controller has not properly configured state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 default_key_not_allowed: summary: default_key_not_allowed value: code: default_key_not_allowed http_status_code: 400 message: Default key cannot be defined for translatable variables parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 display_name_has_illegal_character: summary: display_name_has_illegal_character value: code: display_name_has_illegal_character http_status_code: 400 message: >- Setting display name contains illegal characters, it should contain alphanumeric, space, dash, parenthesis, slash, colon, underscore, dollar, apostrophe and percentage only parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_syntax: summary: expression_invalid_syntax value: code: expression_invalid_syntax http_status_code: 400 message: Campaign build failed due expression invalid syntax parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_not_found: summary: external_element_not_found value: code: external_element_not_found http_status_code: 400 message: External element not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_type_not_supported: summary: external_element_type_not_supported value: code: external_element_type_not_supported http_status_code: 400 message: External element type not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_id: summary: invalid_campaign_id value: code: invalid_campaign_id http_status_code: 400 message: Invalid Campaign Id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_version: summary: invalid_campaign_version value: code: invalid_campaign_version http_status_code: 400 message: Invalid Campaign Version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_element_filter: summary: invalid_external_element_filter value: code: invalid_external_element_filter http_status_code: 400 message: 'Invalid external element filter, expected format: type:id' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_incoming_url: summary: invalid_incoming_url value: code: invalid_incoming_url http_status_code: 400 message: Incoming URL is an invalid URI parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_setting_filter: summary: invalid_setting_filter value: code: invalid_setting_filter http_status_code: 400 message: >- Invalid setting filter, expected format: name:value; backslash escapes the next character (e.g. \, \: \\) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_translatable_value: summary: invalid_translatable_value value: code: invalid_translatable_value http_status_code: 400 message: Translatable variable value is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_uri_in_json: summary: invalid_uri_in_json value: code: invalid_uri_in_json http_status_code: 400 message: Invalid URI in JSON parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 lock_missing_lock_types: summary: lock_missing_lock_types value: code: lock_missing_lock_types http_status_code: 400 message: Unable to unlock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 multiple_components_installed_into_single_socket: summary: multiple_components_installed_into_single_socket value: code: multiple_components_installed_into_single_socket http_status_code: 400 message: Multiple components are installed into a single socket parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 non_translatable_variable_can_not_be_updated: summary: non_translatable_variable_can_not_be_updated value: code: non_translatable_variable_can_not_be_updated http_status_code: 400 message: Only translatable variables are allowed for updated parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 rebuild_campaigns_build_failed: summary: rebuild_campaigns_build_failed value: code: rebuild_campaigns_build_failed http_status_code: 400 message: Rebuild campaigns build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_id_list_invalid_configuration: summary: reward_supplier_id_list_invalid_configuration value: code: reward_supplier_id_list_invalid_configuration http_status_code: 400 message: >- Invalid value configured, allowed values are reward supplier ids that are configured under the allowed_reward_supplier_ids variable parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_batch_update_missing_request: summary: setting_batch_update_missing_request value: code: setting_batch_update_missing_request http_status_code: 400 message: Batch update request has a null entry parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_display_name_length_out_of_range: summary: setting_display_name_length_out_of_range value: code: setting_display_name_length_out_of_range http_status_code: 400 message: Setting display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_component_facet_name_missing: summary: setting_filter_component_facet_name_missing value: code: setting_filter_component_facet_name_missing http_status_code: 400 message: Setting filter component facet name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_component_facet_value_missing: summary: setting_filter_component_facet_value_missing value: code: setting_filter_component_facet_value_missing http_status_code: 400 message: Setting filter component facet value is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_component_type_missing: summary: setting_filter_component_type_missing value: code: setting_filter_component_type_missing http_status_code: 400 message: Setting filter component type is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_expression_evaluation_failed: summary: setting_filter_expression_evaluation_failed value: code: setting_filter_expression_evaluation_failed http_status_code: 400 message: Expression evaluation failed and filtering cannot be applied parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_invalid_component_facet: summary: setting_filter_invalid_component_facet value: code: setting_filter_invalid_component_facet http_status_code: 400 message: Setting filter component facet is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_filter_invalid_component_type: summary: setting_filter_invalid_component_type value: code: setting_filter_invalid_component_type http_status_code: 400 message: Setting filter component type is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_name_duplicated: summary: setting_name_duplicated value: code: setting_name_duplicated http_status_code: 400 message: Setting names should be unique parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_name_length_out_of_range: summary: setting_name_length_out_of_range value: code: setting_name_length_out_of_range http_status_code: 400 message: Setting name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_name_missing: summary: setting_name_missing value: code: setting_name_missing http_status_code: 400 message: Setting name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_name_reserved: summary: setting_name_reserved value: code: setting_name_reserved http_status_code: 400 message: Setting name is a reserved keyword parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_not_found: summary: setting_not_found value: code: setting_not_found http_status_code: 400 message: Setting is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 setting_validation_exception: summary: setting_validation_exception value: code: setting_validation_exception http_status_code: 400 message: Failed to validate setting property parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 settings_build_failed: summary: settings_build_failed value: code: settings_build_failed http_status_code: 400 message: Component settings build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 socket_missing_required_parameter: summary: socket_missing_required_parameter value: code: socket_missing_required_parameter http_status_code: 400 message: Socket is missing required parameter parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 socket_not_found: summary: socket_not_found value: code: socket_not_found http_status_code: 400 message: Socket is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 tag_length_out_of_range: summary: tag_length_out_of_range value: code: tag_length_out_of_range http_status_code: 400 message: Setting tag length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unavailable_referenced_variable: summary: unavailable_referenced_variable value: code: unavailable_referenced_variable http_status_code: 400 message: Unavailable referenced variable parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unexpected_setting_type: summary: unexpected_setting_type value: code: unexpected_setting_type http_status_code: 400 message: Setting is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unknown_source_clients: summary: unknown_source_clients value: code: unknown_source_clients http_status_code: 400 message: Some source client ids are unknown parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_batch_update_has_duplicated_variable_name: summary: variable_batch_update_has_duplicated_variable_name value: code: variable_batch_update_has_duplicated_variable_name http_status_code: 400 message: Batch update request has duplicated variable name for an absolute name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_batch_update_invalid_type: summary: variable_batch_update_invalid_type value: code: variable_batch_update_invalid_type http_status_code: 400 message: Invalid variables type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_batch_update_missing_type: summary: variable_batch_update_missing_type value: code: variable_batch_update_missing_type http_status_code: 400 message: Missing variables types parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_circular_reference: summary: variable_circular_reference value: code: variable_circular_reference http_status_code: 400 message: Variable circular reference parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_description_length_out_of_range: summary: variable_description_length_out_of_range value: code: variable_description_length_out_of_range http_status_code: 400 message: Variable description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_value_invalid_type: summary: variable_value_invalid_type value: code: variable_value_invalid_type http_status_code: 400 message: Variable value has invalid type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_value_key_length_out_of_range: summary: variable_value_key_length_out_of_range value: code: variable_value_key_length_out_of_range http_status_code: 400 message: Variable value key length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ```` ## Related topics - [Select components for a component reference list](https://docs.extole.com/api-reference/components/select-components-for-a-component-reference-list.md) - [List components](https://docs.extole.com/api-reference/components/list-components.md) - [Add component to setting](https://docs.extole.com/api-reference/components/add-component-to-setting.md) - [Unselect components for a component reference list](https://docs.extole.com/api-reference/components/unselect-components-for-a-component-reference-list.md) - [List selected components for a component reference](https://docs.extole.com/api-reference/components/list-selected-components-for-a-component-reference.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.