openapi: 3.0.1 info: description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.' title: Integration API - Consumer to Extole Audiences Campaigns API version: '1.0' servers: - description: Production url: https://{brand}.extole.io variables: brand: default: yourcompany description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io) security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Campaigns paths: /v2/campaign-summaries: get: description: Returns lightweight read-only summaries of campaigns, including id, name, state, and dates. Supports filtering via query parameters. operationId: listCampaignSummaries parameters: - in: query name: version schema: type: string - in: query name: program_type schema: type: string - in: query name: tags schema: items: type: string type: array uniqueItems: true - in: query name: labels schema: items: type: string type: array uniqueItems: true - in: query name: program_label schema: type: string - in: query name: states schema: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true - in: query name: include_archived schema: type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignSummaryResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List campaign summaries tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaign-summaries/{campaignId}{version}: get: description: Returns a lightweight read-only summary of the specified campaign, including id, name, state, and dates. operationId: getCampaignSummary parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignSummaryResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Get a campaign summary tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns: get: description: Returns campaigns for the calling client, filtered and ordered by the supplied query parameters. Supports filtering by state (draft, published, archived), label, and date range. Use `GET /v2/campaigns/built` for fully evaluated runtime forms. operationId: listCampaigns parameters: - in: query name: version schema: type: string - in: query name: reward_supplier_id schema: type: string - in: query name: tags schema: items: type: string type: array uniqueItems: true - in: query name: include_archived schema: type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List campaigns tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible post: description: Creates a new campaign by importing a campaign ZIP archive previously exported via `GET /v2/campaigns/{id}.zip`. All components, controllers, flow steps, and creative assets contained in the archive are imported and the new campaign is created in DRAFT state with a server-assigned id. operationId: uploadNewCampaignArchive requestBody: content: multipart/form-data: example: file: creationDate: '2025-10-24T09:00:00.000Z' fileName: fileName modificationDate: '2025-10-24T09:00:00.000Z' name: name parameters: parameters_key: parameters_key readDate: '2025-10-24T09:00:00.000Z' size: 1 type: type schema: properties: file: $ref: '#/components/schemas/FormDataContentDisposition' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: action_count_invalid: $ref: '#/components/examples/action_count_invalid' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_duplicate_controller: $ref: '#/components/examples/campaign_controller_duplicate_controller' campaign_controller_invalid_enabled_on_state: $ref: '#/components/examples/campaign_controller_invalid_enabled_on_state' campaign_controller_missing_event_trigger: $ref: '#/components/examples/campaign_controller_missing_event_trigger' campaign_controller_missing_journey_name: $ref: '#/components/examples/campaign_controller_missing_journey_name' campaign_controller_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_name_contains_illegal_character' campaign_controller_name_missing: $ref: '#/components/examples/campaign_controller_name_missing' campaign_controller_name_out_of_range: $ref: '#/components/examples/campaign_controller_name_out_of_range' campaign_controller_name_same_as_a_default_controller_name: $ref: '#/components/examples/campaign_controller_name_same_as_a_default_controller_name' campaign_controller_too_many_journey_names: $ref: '#/components/examples/campaign_controller_too_many_journey_names' campaign_flow_step_app_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_description_length_out_of_range' campaign_flow_step_app_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_name_length_out_of_range' campaign_flow_step_app_name_missing: $ref: '#/components/examples/campaign_flow_step_app_name_missing' campaign_flow_step_app_type_missing: $ref: '#/components/examples/campaign_flow_step_app_type_missing' campaign_flow_step_app_type_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_type_name_length_out_of_range' campaign_flow_step_app_type_name_missing: $ref: '#/components/examples/campaign_flow_step_app_type_name_missing' campaign_flow_step_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_description_length_out_of_range' campaign_flow_step_flow_path_invalid: $ref: '#/components/examples/campaign_flow_step_flow_path_invalid' campaign_flow_step_flow_path_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_flow_path_length_out_of_range' campaign_flow_step_flow_path_missing: $ref: '#/components/examples/campaign_flow_step_flow_path_missing' campaign_flow_step_icon_color_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_icon_color_length_out_of_range' campaign_flow_step_icon_type_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_icon_type_length_out_of_range' campaign_flow_step_icon_type_missing: $ref: '#/components/examples/campaign_flow_step_icon_type_missing' campaign_flow_step_metric_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_description_length_out_of_range' campaign_flow_step_metric_duplicate_exists: $ref: '#/components/examples/campaign_flow_step_metric_duplicate_exists' campaign_flow_step_metric_expression_invalid: $ref: '#/components/examples/campaign_flow_step_metric_expression_invalid' campaign_flow_step_metric_expression_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_expression_length_out_of_range' campaign_flow_step_metric_expression_missing: $ref: '#/components/examples/campaign_flow_step_metric_expression_missing' campaign_flow_step_metric_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_name_length_out_of_range' campaign_flow_step_metric_name_missing: $ref: '#/components/examples/campaign_flow_step_metric_name_missing' campaign_flow_step_metric_tags_missing: $ref: '#/components/examples/campaign_flow_step_metric_tags_missing' campaign_flow_step_metric_unit_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_unit_length_out_of_range' campaign_flow_step_metric_unit_missing: $ref: '#/components/examples/campaign_flow_step_metric_unit_missing' campaign_flow_step_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_name_length_out_of_range' campaign_flow_step_sequence_invalid: $ref: '#/components/examples/campaign_flow_step_sequence_invalid' campaign_flow_step_sequence_missing: $ref: '#/components/examples/campaign_flow_step_sequence_missing' campaign_flow_step_step_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_step_name_length_out_of_range' campaign_flow_step_step_name_missing: $ref: '#/components/examples/campaign_flow_step_step_name_missing' campaign_flow_step_word_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_word_length_out_of_range' campaign_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_invalid_tag: $ref: '#/components/examples/campaign_invalid_tag' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_tags_too_long: $ref: '#/components/examples/campaign_tags_too_long' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_asset_content_length_out_of_range: $ref: '#/components/examples/component_asset_content_length_out_of_range' component_asset_content_missing: $ref: '#/components/examples/component_asset_content_missing' component_asset_content_upload_error: $ref: '#/components/examples/component_asset_content_upload_error' component_asset_description_length_out_of_range: $ref: '#/components/examples/component_asset_description_length_out_of_range' component_asset_filename_contains_illegal_character: $ref: '#/components/examples/component_asset_filename_contains_illegal_character' component_asset_filename_length_out_of_range: $ref: '#/components/examples/component_asset_filename_length_out_of_range' component_asset_filename_missing: $ref: '#/components/examples/component_asset_filename_missing' component_asset_name_contains_illegal_character: $ref: '#/components/examples/component_asset_name_contains_illegal_character' component_asset_name_duplicated: $ref: '#/components/examples/component_asset_name_duplicated' component_asset_name_length_out_of_range: $ref: '#/components/examples/component_asset_name_length_out_of_range' component_asset_name_missing: $ref: '#/components/examples/component_asset_name_missing' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' component_id_not_accessible: $ref: '#/components/examples/component_id_not_accessible' component_type_not_found: $ref: '#/components/examples/component_type_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' creative_archive_size_too_big: $ref: '#/components/examples/creative_archive_size_too_big' creative_asset_file_path_invalid: $ref: '#/components/examples/creative_asset_file_path_invalid' creative_asset_file_path_too_long: $ref: '#/components/examples/creative_asset_file_path_too_long' creative_asset_file_size_too_big: $ref: '#/components/examples/creative_asset_file_size_too_big' creative_asset_invalid_character_encoding: $ref: '#/components/examples/creative_asset_invalid_character_encoding' creative_has_default_locale_disabled: $ref: '#/components/examples/creative_has_default_locale_disabled' creative_has_incompatible_api_version: $ref: '#/components/examples/creative_has_incompatible_api_version' creative_has_invalid_api_version: $ref: '#/components/examples/creative_has_invalid_api_version' creative_has_invalid_locale: $ref: '#/components/examples/creative_has_invalid_locale' creative_has_unknown_classification: $ref: '#/components/examples/creative_has_unknown_classification' creative_is_missing_attributes: $ref: '#/components/examples/creative_is_missing_attributes' creative_is_missing_renderer: $ref: '#/components/examples/creative_is_missing_renderer' creative_mismatch_api_version: $ref: '#/components/examples/creative_mismatch_api_version' data_attribute_name_out_of_range: $ref: '#/components/examples/data_attribute_name_out_of_range' data_attribute_regexp_invalid: $ref: '#/components/examples/data_attribute_regexp_invalid' data_attribute_value_out_of_range: $ref: '#/components/examples/data_attribute_value_out_of_range' data_attribute_value_type_required: $ref: '#/components/examples/data_attribute_value_type_required' 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' download_error: $ref: '#/components/examples/download_error' duplicate_step_data_name: $ref: '#/components/examples/duplicate_step_data_name' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' expression_invalid_type: $ref: '#/components/examples/expression_invalid_type' expression_missing_type: $ref: '#/components/examples/expression_missing_type' expression_missing_value: $ref: '#/components/examples/expression_missing_value' expression_value_invalid: $ref: '#/components/examples/expression_value_invalid' expression_value_invalid_length: $ref: '#/components/examples/expression_value_invalid_length' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' identity_key_incompatible_usage: $ref: '#/components/examples/identity_key_incompatible_usage' invalid_archive_id: $ref: '#/components/examples/invalid_archive_id' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_program_type: $ref: '#/components/examples/invalid_program_type' invalid_step_alias: $ref: '#/components/examples/invalid_step_alias' invalid_theme_name: $ref: '#/components/examples/invalid_theme_name' invalid_translatable_value: $ref: '#/components/examples/invalid_translatable_value' javascript_error: $ref: '#/components/examples/javascript_error' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' min_cart_value_invalid: $ref: '#/components/examples/min_cart_value_invalid' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_step_data_name: $ref: '#/components/examples/missing_step_data_name' missing_step_data_value: $ref: '#/components/examples/missing_step_data_value' multiple_components_installed_into_single_socket: $ref: '#/components/examples/multiple_components_installed_into_single_socket' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' non_translatable_variable_can_not_be_updated: $ref: '#/components/examples/non_translatable_variable_can_not_be_updated' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' program_type_empty: $ref: '#/components/examples/program_type_empty' quality_rule_property_invalid_regexp: $ref: '#/components/examples/quality_rule_property_invalid_regexp' quality_rule_property_invalid_value_count: $ref: '#/components/examples/quality_rule_property_invalid_value_count' quality_rule_property_key_invalid_character: $ref: '#/components/examples/quality_rule_property_key_invalid_character' quality_rule_property_key_invalid_length: $ref: '#/components/examples/quality_rule_property_key_invalid_length' quality_rule_property_key_unsupported: $ref: '#/components/examples/quality_rule_property_key_unsupported' quality_rule_property_value_invalid_boolean: $ref: '#/components/examples/quality_rule_property_value_invalid_boolean' quality_rule_property_value_invalid_character: $ref: '#/components/examples/quality_rule_property_value_invalid_character' quality_rule_property_value_invalid_country: $ref: '#/components/examples/quality_rule_property_value_invalid_country' quality_rule_property_value_invalid_expression_type: $ref: '#/components/examples/quality_rule_property_value_invalid_expression_type' quality_rule_property_value_invalid_length: $ref: '#/components/examples/quality_rule_property_value_invalid_length' quality_rule_property_value_invalid_number: $ref: '#/components/examples/quality_rule_property_value_invalid_number' quality_rule_property_value_invalid_subnet: $ref: '#/components/examples/quality_rule_property_value_invalid_subnet' quality_rule_property_value_invalid_temporal_unit: $ref: '#/components/examples/quality_rule_property_value_invalid_temporal_unit' quality_rule_property_value_invalid_time_unit: $ref: '#/components/examples/quality_rule_property_value_invalid_time_unit' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reserved_name: $ref: '#/components/examples/reserved_name' reward_count_limit_invalid: $ref: '#/components/examples/reward_count_limit_invalid' reward_count_since_days_invalid: $ref: '#/components/examples/reward_count_since_days_invalid' reward_count_since_month_invalid: $ref: '#/components/examples/reward_count_since_month_invalid' reward_every_x_friend_actions_invalid: $ref: '#/components/examples/reward_every_x_friend_actions_invalid' reward_slots_concatenated_length_exception: $ref: '#/components/examples/reward_slots_concatenated_length_exception' reward_slots_invalid_name: $ref: '#/components/examples/reward_slots_invalid_name' reward_slots_out_of_range: $ref: '#/components/examples/reward_slots_out_of_range' reward_supplier_id_list_invalid_configuration: $ref: '#/components/examples/reward_supplier_id_list_invalid_configuration' reward_value_limit_invalid: $ref: '#/components/examples/reward_value_limit_invalid' reward_value_since_days_invalid: $ref: '#/components/examples/reward_value_since_days_invalid' reward_value_since_month_invalid: $ref: '#/components/examples/reward_value_since_month_invalid' self_component_reference: $ref: '#/components/examples/self_component_reference' 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' step_data_default_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_default_value_expression_length_out_of_range' step_data_name_length_out_of_range: $ref: '#/components/examples/step_data_name_length_out_of_range' step_data_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_value_expression_length_out_of_range' tag_length_out_of_range: $ref: '#/components/examples/tag_length_out_of_range' unavailable_referenced_variable: $ref: '#/components/examples/unavailable_referenced_variable' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' upload_error: $ref: '#/components/examples/upload_error' 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' variable_value_missing: $ref: '#/components/examples/variable_value_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' action_type_already_exists: $ref: '#/components/examples/action_type_already_exists' campaign_description_out_of_range: $ref: '#/components/examples/campaign_description_out_of_range' campaign_label_name_already_in_use: $ref: '#/components/examples/campaign_label_name_already_in_use' campaign_label_name_contains_illegal_character: $ref: '#/components/examples/campaign_label_name_contains_illegal_character' campaign_label_name_missing: $ref: '#/components/examples/campaign_label_name_missing' campaign_label_name_out_of_range: $ref: '#/components/examples/campaign_label_name_out_of_range' campaign_name_already_used: $ref: '#/components/examples/campaign_name_already_used' campaign_name_illegal_character: $ref: '#/components/examples/campaign_name_illegal_character' campaign_name_is_missing: $ref: '#/components/examples/campaign_name_is_missing' campaign_name_out_of_range: $ref: '#/components/examples/campaign_name_out_of_range' invalid_campaign_archive: $ref: '#/components/examples/invalid_campaign_archive' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' missing_campaign_json: $ref: '#/components/examples/missing_campaign_json' transition_period_milliseconds_invalid: $ref: '#/components/examples/transition_period_milliseconds_invalid' 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 summary: Upload a new campaign from archive tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/built: get: description: Returns campaigns in their fully evaluated (built) runtime form, with all evaluatable fields resolved. Use this when the calling system needs effective component values and settings rather than source definitions. Supports the same filtering as `GET /v2/campaigns`. operationId: listBuiltCampaigns parameters: - in: query name: version schema: type: string - in: query name: reward_supplier_id schema: type: string - in: query name: program_label schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltCampaignResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List built campaigns tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/deleted: get: description: Returns the campaigns that have been soft-deleted for the calling client. Deleted campaigns are retained for audit and recovery purposes. Use `POST /v2/campaigns/{id}/undelete` to restore a deleted campaign. operationId: getDeletedCampaigns responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List deleted campaigns tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/duplicatable: get: description: Returns the campaigns that the calling client is permitted to duplicate. Duplicatable campaigns include both the client's own draft and published campaigns and any shared template campaigns. Use `POST /v2/campaigns/{id}/duplicate` to create a copy. operationId: getDuplicatableCampaigns responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List duplicatable campaigns tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}/versions: get: description: Returns the version history for the specified campaign, ordered from most recent to oldest. Each entry includes the version identifier, state, and timestamps. Supports `limit` and `offset` query parameters for pagination. operationId: getVersions parameters: - in: path name: campaignId required: true schema: type: string - in: query name: limit schema: nullable: true type: string - in: query name: offset schema: nullable: true type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignVersionDescriptionResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: List campaign versions tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}/versions/{campaignVersion}: get: description: Returns the version descriptor for the specified campaign version identifier. Includes the version's state, author, and timestamps. Use `GET /v2/campaigns/{id}/version/{version}` to retrieve the full campaign definition for that version. operationId: getVersion parameters: - in: path name: campaignId required: true schema: type: string - in: path name: campaignVersion required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignVersionDescriptionResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Get a campaign version tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}: get: description: Returns the source definition of the supplied campaign version. Omit the `/version/{version}` path segment to retrieve the latest version. Use `GET /v2/campaigns/{id}/built` for the fully evaluated runtime form. operationId: getCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Campaign definition. '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 '404': content: application/json: examples: campaign_not_found: $ref: '#/components/examples/campaign_not_found' description: Campaign was not found. The supplied id does not match any campaign accessible to the calling client. '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 summary: Get a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible put: description: Replaces the content of the specified campaign version with a campaign ZIP archive. All components, controllers, flow steps, and creative assets in the archive overwrite the existing campaign definition. The `version` path segment acts as an optimistic-lock guard; supply the current version to prevent lost-update races. operationId: updateWithCampaignArchive parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: multipart/form-data: example: file: creationDate: '2025-10-24T09:00:00.000Z' fileName: fileName modificationDate: '2025-10-24T09:00:00.000Z' name: name parameters: parameters_key: parameters_key readDate: '2025-10-24T09:00:00.000Z' size: 1 type: type schema: properties: file: $ref: '#/components/schemas/FormDataContentDisposition' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: action_count_invalid: $ref: '#/components/examples/action_count_invalid' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_duplicate_controller: $ref: '#/components/examples/campaign_controller_duplicate_controller' campaign_controller_invalid_enabled_on_state: $ref: '#/components/examples/campaign_controller_invalid_enabled_on_state' campaign_controller_missing_event_trigger: $ref: '#/components/examples/campaign_controller_missing_event_trigger' campaign_controller_missing_journey_name: $ref: '#/components/examples/campaign_controller_missing_journey_name' campaign_controller_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_name_contains_illegal_character' campaign_controller_name_missing: $ref: '#/components/examples/campaign_controller_name_missing' campaign_controller_name_out_of_range: $ref: '#/components/examples/campaign_controller_name_out_of_range' campaign_controller_name_same_as_a_default_controller_name: $ref: '#/components/examples/campaign_controller_name_same_as_a_default_controller_name' campaign_controller_too_many_journey_names: $ref: '#/components/examples/campaign_controller_too_many_journey_names' campaign_flow_step_app_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_description_length_out_of_range' campaign_flow_step_app_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_name_length_out_of_range' campaign_flow_step_app_name_missing: $ref: '#/components/examples/campaign_flow_step_app_name_missing' campaign_flow_step_app_type_missing: $ref: '#/components/examples/campaign_flow_step_app_type_missing' campaign_flow_step_app_type_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_app_type_name_length_out_of_range' campaign_flow_step_app_type_name_missing: $ref: '#/components/examples/campaign_flow_step_app_type_name_missing' campaign_flow_step_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_description_length_out_of_range' campaign_flow_step_flow_path_invalid: $ref: '#/components/examples/campaign_flow_step_flow_path_invalid' campaign_flow_step_flow_path_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_flow_path_length_out_of_range' campaign_flow_step_flow_path_missing: $ref: '#/components/examples/campaign_flow_step_flow_path_missing' campaign_flow_step_icon_color_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_icon_color_length_out_of_range' campaign_flow_step_icon_type_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_icon_type_length_out_of_range' campaign_flow_step_icon_type_missing: $ref: '#/components/examples/campaign_flow_step_icon_type_missing' campaign_flow_step_metric_description_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_description_length_out_of_range' campaign_flow_step_metric_duplicate_exists: $ref: '#/components/examples/campaign_flow_step_metric_duplicate_exists' campaign_flow_step_metric_expression_invalid: $ref: '#/components/examples/campaign_flow_step_metric_expression_invalid' campaign_flow_step_metric_expression_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_expression_length_out_of_range' campaign_flow_step_metric_expression_missing: $ref: '#/components/examples/campaign_flow_step_metric_expression_missing' campaign_flow_step_metric_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_name_length_out_of_range' campaign_flow_step_metric_name_missing: $ref: '#/components/examples/campaign_flow_step_metric_name_missing' campaign_flow_step_metric_tags_missing: $ref: '#/components/examples/campaign_flow_step_metric_tags_missing' campaign_flow_step_metric_unit_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_metric_unit_length_out_of_range' campaign_flow_step_metric_unit_missing: $ref: '#/components/examples/campaign_flow_step_metric_unit_missing' campaign_flow_step_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_name_length_out_of_range' campaign_flow_step_sequence_invalid: $ref: '#/components/examples/campaign_flow_step_sequence_invalid' campaign_flow_step_sequence_missing: $ref: '#/components/examples/campaign_flow_step_sequence_missing' campaign_flow_step_step_name_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_step_name_length_out_of_range' campaign_flow_step_step_name_missing: $ref: '#/components/examples/campaign_flow_step_step_name_missing' campaign_flow_step_word_length_out_of_range: $ref: '#/components/examples/campaign_flow_step_word_length_out_of_range' campaign_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_invalid_tag: $ref: '#/components/examples/campaign_invalid_tag' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_tags_too_long: $ref: '#/components/examples/campaign_tags_too_long' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_asset_content_length_out_of_range: $ref: '#/components/examples/component_asset_content_length_out_of_range' component_asset_content_missing: $ref: '#/components/examples/component_asset_content_missing' component_asset_content_upload_error: $ref: '#/components/examples/component_asset_content_upload_error' component_asset_description_length_out_of_range: $ref: '#/components/examples/component_asset_description_length_out_of_range' component_asset_filename_contains_illegal_character: $ref: '#/components/examples/component_asset_filename_contains_illegal_character' component_asset_filename_length_out_of_range: $ref: '#/components/examples/component_asset_filename_length_out_of_range' component_asset_filename_missing: $ref: '#/components/examples/component_asset_filename_missing' component_asset_name_contains_illegal_character: $ref: '#/components/examples/component_asset_name_contains_illegal_character' component_asset_name_duplicated: $ref: '#/components/examples/component_asset_name_duplicated' component_asset_name_length_out_of_range: $ref: '#/components/examples/component_asset_name_length_out_of_range' component_asset_name_missing: $ref: '#/components/examples/component_asset_name_missing' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' component_id_not_accessible: $ref: '#/components/examples/component_id_not_accessible' component_type_not_found: $ref: '#/components/examples/component_type_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' creative_archive_size_too_big: $ref: '#/components/examples/creative_archive_size_too_big' creative_asset_file_path_invalid: $ref: '#/components/examples/creative_asset_file_path_invalid' creative_asset_file_path_too_long: $ref: '#/components/examples/creative_asset_file_path_too_long' creative_asset_file_size_too_big: $ref: '#/components/examples/creative_asset_file_size_too_big' creative_asset_invalid_character_encoding: $ref: '#/components/examples/creative_asset_invalid_character_encoding' creative_has_default_locale_disabled: $ref: '#/components/examples/creative_has_default_locale_disabled' creative_has_incompatible_api_version: $ref: '#/components/examples/creative_has_incompatible_api_version' creative_has_invalid_api_version: $ref: '#/components/examples/creative_has_invalid_api_version' creative_has_invalid_locale: $ref: '#/components/examples/creative_has_invalid_locale' creative_has_unknown_classification: $ref: '#/components/examples/creative_has_unknown_classification' creative_is_missing_attributes: $ref: '#/components/examples/creative_is_missing_attributes' creative_is_missing_renderer: $ref: '#/components/examples/creative_is_missing_renderer' creative_mismatch_api_version: $ref: '#/components/examples/creative_mismatch_api_version' data_attribute_name_out_of_range: $ref: '#/components/examples/data_attribute_name_out_of_range' data_attribute_regexp_invalid: $ref: '#/components/examples/data_attribute_regexp_invalid' data_attribute_value_out_of_range: $ref: '#/components/examples/data_attribute_value_out_of_range' data_attribute_value_type_required: $ref: '#/components/examples/data_attribute_value_type_required' 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' download_error: $ref: '#/components/examples/download_error' duplicate_step_data_name: $ref: '#/components/examples/duplicate_step_data_name' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' expression_invalid_type: $ref: '#/components/examples/expression_invalid_type' expression_missing_type: $ref: '#/components/examples/expression_missing_type' expression_missing_value: $ref: '#/components/examples/expression_missing_value' expression_value_invalid: $ref: '#/components/examples/expression_value_invalid' expression_value_invalid_length: $ref: '#/components/examples/expression_value_invalid_length' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' identity_key_incompatible_usage: $ref: '#/components/examples/identity_key_incompatible_usage' invalid_archive_id: $ref: '#/components/examples/invalid_archive_id' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_program_type: $ref: '#/components/examples/invalid_program_type' invalid_step_alias: $ref: '#/components/examples/invalid_step_alias' invalid_theme_name: $ref: '#/components/examples/invalid_theme_name' invalid_translatable_value: $ref: '#/components/examples/invalid_translatable_value' javascript_error: $ref: '#/components/examples/javascript_error' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' min_cart_value_invalid: $ref: '#/components/examples/min_cart_value_invalid' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_step_data_name: $ref: '#/components/examples/missing_step_data_name' missing_step_data_value: $ref: '#/components/examples/missing_step_data_value' multiple_components_installed_into_single_socket: $ref: '#/components/examples/multiple_components_installed_into_single_socket' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' non_translatable_variable_can_not_be_updated: $ref: '#/components/examples/non_translatable_variable_can_not_be_updated' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' program_type_empty: $ref: '#/components/examples/program_type_empty' quality_rule_property_invalid_regexp: $ref: '#/components/examples/quality_rule_property_invalid_regexp' quality_rule_property_invalid_value_count: $ref: '#/components/examples/quality_rule_property_invalid_value_count' quality_rule_property_key_invalid_character: $ref: '#/components/examples/quality_rule_property_key_invalid_character' quality_rule_property_key_invalid_length: $ref: '#/components/examples/quality_rule_property_key_invalid_length' quality_rule_property_key_unsupported: $ref: '#/components/examples/quality_rule_property_key_unsupported' quality_rule_property_value_invalid_boolean: $ref: '#/components/examples/quality_rule_property_value_invalid_boolean' quality_rule_property_value_invalid_character: $ref: '#/components/examples/quality_rule_property_value_invalid_character' quality_rule_property_value_invalid_country: $ref: '#/components/examples/quality_rule_property_value_invalid_country' quality_rule_property_value_invalid_expression_type: $ref: '#/components/examples/quality_rule_property_value_invalid_expression_type' quality_rule_property_value_invalid_length: $ref: '#/components/examples/quality_rule_property_value_invalid_length' quality_rule_property_value_invalid_number: $ref: '#/components/examples/quality_rule_property_value_invalid_number' quality_rule_property_value_invalid_subnet: $ref: '#/components/examples/quality_rule_property_value_invalid_subnet' quality_rule_property_value_invalid_temporal_unit: $ref: '#/components/examples/quality_rule_property_value_invalid_temporal_unit' quality_rule_property_value_invalid_time_unit: $ref: '#/components/examples/quality_rule_property_value_invalid_time_unit' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reserved_name: $ref: '#/components/examples/reserved_name' reward_count_limit_invalid: $ref: '#/components/examples/reward_count_limit_invalid' reward_count_since_days_invalid: $ref: '#/components/examples/reward_count_since_days_invalid' reward_count_since_month_invalid: $ref: '#/components/examples/reward_count_since_month_invalid' reward_every_x_friend_actions_invalid: $ref: '#/components/examples/reward_every_x_friend_actions_invalid' reward_slots_concatenated_length_exception: $ref: '#/components/examples/reward_slots_concatenated_length_exception' reward_slots_invalid_name: $ref: '#/components/examples/reward_slots_invalid_name' reward_slots_out_of_range: $ref: '#/components/examples/reward_slots_out_of_range' reward_supplier_id_list_invalid_configuration: $ref: '#/components/examples/reward_supplier_id_list_invalid_configuration' reward_value_limit_invalid: $ref: '#/components/examples/reward_value_limit_invalid' reward_value_since_days_invalid: $ref: '#/components/examples/reward_value_since_days_invalid' reward_value_since_month_invalid: $ref: '#/components/examples/reward_value_since_month_invalid' self_component_reference: $ref: '#/components/examples/self_component_reference' 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' step_data_default_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_default_value_expression_length_out_of_range' step_data_name_length_out_of_range: $ref: '#/components/examples/step_data_name_length_out_of_range' step_data_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_value_expression_length_out_of_range' tag_length_out_of_range: $ref: '#/components/examples/tag_length_out_of_range' unavailable_referenced_variable: $ref: '#/components/examples/unavailable_referenced_variable' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' upload_error: $ref: '#/components/examples/upload_error' 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' variable_value_missing: $ref: '#/components/examples/variable_value_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' action_type_already_exists: $ref: '#/components/examples/action_type_already_exists' campaign_description_out_of_range: $ref: '#/components/examples/campaign_description_out_of_range' campaign_label_name_already_in_use: $ref: '#/components/examples/campaign_label_name_already_in_use' campaign_label_name_contains_illegal_character: $ref: '#/components/examples/campaign_label_name_contains_illegal_character' campaign_label_name_missing: $ref: '#/components/examples/campaign_label_name_missing' campaign_label_name_out_of_range: $ref: '#/components/examples/campaign_label_name_out_of_range' campaign_name_already_used: $ref: '#/components/examples/campaign_name_already_used' campaign_name_illegal_character: $ref: '#/components/examples/campaign_name_illegal_character' campaign_name_is_missing: $ref: '#/components/examples/campaign_name_is_missing' campaign_name_out_of_range: $ref: '#/components/examples/campaign_name_out_of_range' invalid_campaign_archive: $ref: '#/components/examples/invalid_campaign_archive' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' missing_campaign_json: $ref: '#/components/examples/missing_campaign_json' transition_period_milliseconds_invalid: $ref: '#/components/examples/transition_period_milliseconds_invalid' 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 summary: Update a campaign from archive tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible delete: description: Soft-deletes the specified campaign version. Deleted campaigns are excluded from standard listings but are recoverable via `POST /v2/campaigns/{id}/undelete`. Returns the deleted campaign record. Requires the campaign to be in a state that permits deletion (e.g. DRAFT or ARCHIVED). operationId: deleteCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Delete a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/built: get: description: Returns the specified campaign version in its fully evaluated (built) runtime form, with all evaluatable fields resolved against current component and setting values. Omit the `/version/{version}` segment to retrieve the built form of the latest version. operationId: getBuiltCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Get a built campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}.zip: get: description: Downloads the specified campaign version as a ZIP archive containing all campaign assets, component definitions, and configuration files. The archive can be used to back up a campaign or to import it into another client via `POST /v2/campaigns` or `PUT /v2/campaigns/{id}`. operationId: downloadCampaignBundle parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/zip: schema: format: binary type: string description: Campaign bundle ZIP archive. '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Download a campaign bundle tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/program/{programLabel}/rename: post: description: Renames the specified program label across all campaigns that use it. operationId: renameCampaignsProgramLabel parameters: - in: path name: programLabel required: true schema: type: string requestBody: content: application/json: example: program_label: program_label schema: $ref: '#/components/schemas/CampaignProgramLabelRenameRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' campaign_label_name_already_in_use: $ref: '#/components/examples/campaign_label_name_already_in_use' campaign_label_name_contains_illegal_character: $ref: '#/components/examples/campaign_label_name_contains_illegal_character' campaign_label_name_missing: $ref: '#/components/examples/campaign_label_name_missing' campaign_label_name_out_of_range: $ref: '#/components/examples/campaign_label_name_out_of_range' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' program_label_already_in_use: $ref: '#/components/examples/program_label_already_in_use' program_label_contains_illegal_character: $ref: '#/components/examples/program_label_contains_illegal_character' program_label_missing: $ref: '#/components/examples/program_label_missing' program_label_not_found: $ref: '#/components/examples/program_label_not_found' 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 summary: Rename a campaigns program label tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/archive: post: description: Moves the specified campaign version to archived state, hiding it from default campaign listings while retaining it for reporting and recovery. Use `POST /v2/campaigns/{id}/unarchive` to restore an archived campaign to active state. operationId: archiveCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Archive a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/discard: post: description: Discards the draft version of the specified campaign, reverting it to the last published state. Uncommitted changes made since the last publish are lost. If no published version exists, the campaign remains in draft with its changes removed. operationId: discard parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Discard a campaign draft tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/duplicate: post: description: Creates a new draft campaign by deep-copying the supplied campaign version. The copy inherits all components, settings, and labels; the optional request body lets callers override the new campaign's name and label list. The new campaign is created in DRAFT state regardless of the source's state. operationId: duplicateCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: description: description message: message name: name program_label: program_label schema: $ref: '#/components/schemas/CampaignDuplicateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Duplicated campaign. '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_duplicate_controller: $ref: '#/components/examples/campaign_controller_duplicate_controller' campaign_controller_invalid_enabled_on_state: $ref: '#/components/examples/campaign_controller_invalid_enabled_on_state' campaign_controller_missing_event_trigger: $ref: '#/components/examples/campaign_controller_missing_event_trigger' campaign_controller_missing_journey_name: $ref: '#/components/examples/campaign_controller_missing_journey_name' campaign_controller_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_name_contains_illegal_character' campaign_controller_name_missing: $ref: '#/components/examples/campaign_controller_name_missing' campaign_controller_name_out_of_range: $ref: '#/components/examples/campaign_controller_name_out_of_range' campaign_controller_name_same_as_a_default_controller_name: $ref: '#/components/examples/campaign_controller_name_same_as_a_default_controller_name' campaign_controller_too_many_journey_names: $ref: '#/components/examples/campaign_controller_too_many_journey_names' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_invalid_tag: $ref: '#/components/examples/campaign_invalid_tag' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_tags_too_long: $ref: '#/components/examples/campaign_tags_too_long' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' component_id_not_accessible: $ref: '#/components/examples/component_id_not_accessible' 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' duplicate_step_data_name: $ref: '#/components/examples/duplicate_step_data_name' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_program_type: $ref: '#/components/examples/invalid_program_type' invalid_step_alias: $ref: '#/components/examples/invalid_step_alias' invalid_theme_name: $ref: '#/components/examples/invalid_theme_name' invalid_translatable_value: $ref: '#/components/examples/invalid_translatable_value' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_step_data_name: $ref: '#/components/examples/missing_step_data_name' missing_step_data_value: $ref: '#/components/examples/missing_step_data_value' 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' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' program_type_empty: $ref: '#/components/examples/program_type_empty' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reward_supplier_id_list_invalid_configuration: $ref: '#/components/examples/reward_supplier_id_list_invalid_configuration' self_component_reference: $ref: '#/components/examples/self_component_reference' 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_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' step_data_default_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_default_value_expression_length_out_of_range' step_data_name_length_out_of_range: $ref: '#/components/examples/step_data_name_length_out_of_range' step_data_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_value_expression_length_out_of_range' tag_length_out_of_range: $ref: '#/components/examples/tag_length_out_of_range' unavailable_referenced_variable: $ref: '#/components/examples/unavailable_referenced_variable' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' 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' variable_value_missing: $ref: '#/components/examples/variable_value_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' campaign_description_out_of_range: $ref: '#/components/examples/campaign_description_out_of_range' campaign_label_name_already_in_use: $ref: '#/components/examples/campaign_label_name_already_in_use' campaign_label_name_contains_illegal_character: $ref: '#/components/examples/campaign_label_name_contains_illegal_character' campaign_label_name_missing: $ref: '#/components/examples/campaign_label_name_missing' campaign_label_name_out_of_range: $ref: '#/components/examples/campaign_label_name_out_of_range' campaign_name_already_used: $ref: '#/components/examples/campaign_name_already_used' campaign_name_illegal_character: $ref: '#/components/examples/campaign_name_illegal_character' campaign_name_is_missing: $ref: '#/components/examples/campaign_name_is_missing' campaign_name_out_of_range: $ref: '#/components/examples/campaign_name_out_of_range' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '404': content: application/json: examples: campaign_not_found: $ref: '#/components/examples/campaign_not_found' description: Campaign was not found. The supplied id does not match any campaign accessible to the calling client. '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 summary: Duplicate a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/end: post: description: Transitions the specified campaign version to ended state, permanently closing it to new participants. Ended campaigns are retained for reporting and audit; use `POST /v2/campaigns/{id}/archive` to hide them from active lists. Supports an optional schedule request body to defer the end to a future time. operationId: endCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignScheduleStateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' remove_start_date: $ref: '#/components/examples/remove_start_date' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: End a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/launch-burst: post: description: Transitions the specified campaign version into burst mode, which is a high-throughput live state designed for time-limited promotional surges. Validates all campaign components and reward rules before the transition. Returns the updated campaign on success. operationId: launchBurst parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: message: message start_date: '2025-10-24T02:00:00-07:00' stop_date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignLaunchBurstRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' campaign_controller_duplicate_controller: $ref: '#/components/examples/campaign_controller_duplicate_controller' campaign_controller_invalid_enabled_on_state: $ref: '#/components/examples/campaign_controller_invalid_enabled_on_state' campaign_controller_missing_event_trigger: $ref: '#/components/examples/campaign_controller_missing_event_trigger' campaign_controller_missing_journey_name: $ref: '#/components/examples/campaign_controller_missing_journey_name' campaign_controller_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_name_contains_illegal_character' campaign_controller_name_missing: $ref: '#/components/examples/campaign_controller_name_missing' campaign_controller_name_out_of_range: $ref: '#/components/examples/campaign_controller_name_out_of_range' campaign_controller_name_same_as_a_default_controller_name: $ref: '#/components/examples/campaign_controller_name_same_as_a_default_controller_name' campaign_controller_too_many_journey_names: $ref: '#/components/examples/campaign_controller_too_many_journey_names' campaign_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_step_alias: $ref: '#/components/examples/invalid_step_alias' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' remove_start_date: $ref: '#/components/examples/remove_start_date' reserved_name: $ref: '#/components/examples/reserved_name' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' 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 summary: Launch a campaign in burst mode tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/launch-test: post: description: Transitions the specified campaign version into test mode, enabling a limited rollout to test participants without affecting production traffic. Validates all campaign components, controllers, and reward rules before the transition. Returns the updated campaign on success. operationId: launchTest parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: message: message start_date: '2025-10-24T02:00:00-07:00' stop_date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignLaunchTestRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' campaign_controller_duplicate_controller: $ref: '#/components/examples/campaign_controller_duplicate_controller' campaign_controller_invalid_enabled_on_state: $ref: '#/components/examples/campaign_controller_invalid_enabled_on_state' campaign_controller_missing_event_trigger: $ref: '#/components/examples/campaign_controller_missing_event_trigger' campaign_controller_missing_journey_name: $ref: '#/components/examples/campaign_controller_missing_journey_name' campaign_controller_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_name_contains_illegal_character' campaign_controller_name_missing: $ref: '#/components/examples/campaign_controller_name_missing' campaign_controller_name_out_of_range: $ref: '#/components/examples/campaign_controller_name_out_of_range' campaign_controller_name_same_as_a_default_controller_name: $ref: '#/components/examples/campaign_controller_name_same_as_a_default_controller_name' campaign_controller_too_many_journey_names: $ref: '#/components/examples/campaign_controller_too_many_journey_names' campaign_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_step_alias: $ref: '#/components/examples/invalid_step_alias' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' remove_start_date: $ref: '#/components/examples/remove_start_date' reserved_name: $ref: '#/components/examples/reserved_name' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' 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 summary: Launch a campaign in test mode tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/live: post: description: Transitions the specified campaign version directly to live state, bypassing the normal test-mode phase. Validates all components and reward rules before the transition. Returns the updated campaign. Use `POST /v2/campaigns/{id}/publish` for the standard publish flow with full validation. operationId: liveCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' 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' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' 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 summary: Set a campaign live tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/lock: post: description: Locks the specified campaign version to prevent concurrent edits. While a campaign is locked, attempts to edit it by other callers are rejected with `400 campaign_locked`. The lock is associated with the caller's access token; use `POST /v2/campaigns/{id}/unlock` to release it. operationId: lockCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: lock_types: - DUPLICATE schema: $ref: '#/components/schemas/CampaignLockRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Lock a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/make-latest-draft: post: description: Promotes the specified campaign version to be the latest draft, replacing any existing latest-draft pointer. Useful for rolling back to a prior version that should become the new active draft for editing. The campaign must be in a state that permits draft promotion. operationId: makeLatestDraft parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: message: message version: version schema: $ref: '#/components/schemas/CampaignMakeLatestRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Make a campaign version the latest draft tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/make-latest-preserve-state: post: description: Promotes the specified campaign version to the latest pointer while keeping the campaign's current lifecycle state (draft, published, etc.) unchanged. Unlike `make-latest-draft` or `make-latest-published`, this transition preserves the state the campaign was already in rather than changing it. operationId: makeLatestPreserveState parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: message: message version: version schema: $ref: '#/components/schemas/CampaignMakeLatestRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Make a campaign version latest while preserving state tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/make-latest-published: post: description: Promotes the specified campaign version to be the latest published version, replacing the existing latest-published pointer. Use to roll back live traffic to a prior published version without going through a full publish cycle. The campaign must already be in published state. operationId: makeLatestPublished parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: message: message version: version schema: $ref: '#/components/schemas/CampaignMakeLatestRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Make a campaign version the latest published tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/pause: post: description: Transitions the specified campaign version to paused state, temporarily halting participant eligibility and reward processing. The campaign can be resumed by publishing it again. Supports an optional schedule request body to defer the pause to a future time. operationId: pauseCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignScheduleStateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' remove_start_date: $ref: '#/components/examples/remove_start_date' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Pause a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/publish: post: description: Validates, builds, and publishes the supplied campaign version, making it live for participants. The optional request body lets callers override the publish schedule. Returns the published campaign. Validates all components, controllers, flow steps, and reward rules before publishing; validation failures return descriptive 4xx errors from the various validation exception types. operationId: publishCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: launch: true message: message schema: $ref: '#/components/schemas/CampaignPublishRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Published campaign. '400': content: application/json: examples: campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_locked: $ref: '#/components/examples/campaign_locked' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad request. Inspect the response `code` field for the specific error; common causes include an invalid campaign id, a mismatched version, or a locked campaign. '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' reward_supplier_not_found: $ref: '#/components/examples/reward_supplier_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '404': content: application/json: examples: campaign_not_found: $ref: '#/components/examples/campaign_not_found' description: Campaign was not found. The supplied id does not match any campaign accessible to the calling client. '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 summary: Publish a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/schedule: post: description: Schedules the specified campaign version for a future state transition (e.g. go-live or end) at the datetime specified in the request body. The campaign must be published before it can be scheduled. Replaces any existing schedule on the same campaign version. operationId: scheduleCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: end_date: '2025-10-24T02:00:00-07:00' pause_date: '2025-10-24T02:00:00-07:00' start_date: '2025-10-24T02:00:00-07:00' stop_date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignScheduleRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' remove_start_date: $ref: '#/components/examples/remove_start_date' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Schedule a campaign state change tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/stop: post: description: Immediately stops the specified campaign version, halting all active processing and participant eligibility. Unlike pause, a stopped campaign must be republished to resume. Supports an optional schedule request body to defer the stop to a future time. operationId: stopCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: date: '2025-10-24T02:00:00-07:00' schema: $ref: '#/components/schemas/CampaignScheduleStateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: backdated_start_date: $ref: '#/components/examples/backdated_start_date' backdated_stop_date: $ref: '#/components/examples/backdated_stop_date' 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_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_global_archive: $ref: '#/components/examples/campaign_global_archive' campaign_global_rename: $ref: '#/components/examples/campaign_global_rename' campaign_global_type_change: $ref: '#/components/examples/campaign_global_type_change' 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' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_after_stop_date: $ref: '#/components/examples/date_after_stop_date' date_before_start_date: $ref: '#/components/examples/date_before_start_date' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' non_marketing_state_change: $ref: '#/components/examples/non_marketing_state_change' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' remove_start_date: $ref: '#/components/examples/remove_start_date' settings_build_failed: $ref: '#/components/examples/settings_build_failed' sibling_campaign_scheduled: $ref: '#/components/examples/sibling_campaign_scheduled' start_date_after_stop_date: $ref: '#/components/examples/start_date_after_stop_date' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Stop a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/unarchive: post: description: Restores the specified campaign version from archived state back to its previous active state. After unarchiving, the campaign resumes appearing in standard listings and is eligible for editing or publishing. operationId: unArchiveCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Unarchive a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/undelete: post: description: Recovers a soft-deleted campaign version, restoring it to an active state. Requires the `CLIENT_SUPERUSER` scope. After recovery the campaign appears again in standard listings and can be edited or published. operationId: unDeleteCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' 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' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' 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_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Undelete a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/{campaignId}{version}/unlock: post: description: Releases the edit lock on the specified campaign version. After unlocking, other callers can edit the campaign again. Returns `400 campaign_not_locked` if the campaign is not currently locked by the caller. operationId: unlockCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: lock_types: - DUPLICATE schema: $ref: '#/components/schemas/CampaignUnlockRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' 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' date_invalid: $ref: '#/components/examples/date_invalid' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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 summary: Unlock a campaign tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible /v2/campaigns/program/{program_label}/update: put: description: Applies the specified update to all campaigns associated with the given program label. operationId: updateCampaignsByProgramLabel parameters: - in: path name: program_label required: true schema: type: string requestBody: content: application/json: example: program_type: program_type schema: $ref: '#/components/schemas/CampaignProgramUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_invalid_tag: $ref: '#/components/examples/campaign_invalid_tag' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_tags_too_long: $ref: '#/components/examples/campaign_tags_too_long' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' duplicate_step_data_name: $ref: '#/components/examples/duplicate_step_data_name' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' 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_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_program_type: $ref: '#/components/examples/invalid_program_type' invalid_theme_name: $ref: '#/components/examples/invalid_theme_name' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_step_data_name: $ref: '#/components/examples/missing_step_data_name' missing_step_data_value: $ref: '#/components/examples/missing_step_data_value' program_type_empty: $ref: '#/components/examples/program_type_empty' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' step_data_default_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_default_value_expression_length_out_of_range' step_data_name_length_out_of_range: $ref: '#/components/examples/step_data_name_length_out_of_range' step_data_value_expression_length_out_of_range: $ref: '#/components/examples/step_data_value_expression_length_out_of_range' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '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' campaign_description_out_of_range: $ref: '#/components/examples/campaign_description_out_of_range' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_name_already_used: $ref: '#/components/examples/campaign_name_already_used' campaign_name_illegal_character: $ref: '#/components/examples/campaign_name_illegal_character' campaign_name_is_missing: $ref: '#/components/examples/campaign_name_is_missing' campaign_name_out_of_range: $ref: '#/components/examples/campaign_name_out_of_range' 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 summary: Update campaigns by program label tags: - Campaigns x-extole-bundle: management x-extole-visibility: visible components: examples: campaign_flow_step_name_length_out_of_range: summary: campaign_flow_step_name_length_out_of_range value: code: campaign_flow_step_name_length_out_of_range http_status_code: 400 message: Name length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_step_name_length_out_of_range: summary: campaign_flow_step_step_name_length_out_of_range value: code: campaign_flow_step_step_name_length_out_of_range http_status_code: 400 message: Step name length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_duplicate_exists: summary: campaign_flow_step_metric_duplicate_exists value: code: campaign_flow_step_metric_duplicate_exists http_status_code: 400 message: Another metric with the same name exists in the flow step parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_every_x_friend_actions_invalid: summary: reward_every_x_friend_actions_invalid value: code: reward_every_x_friend_actions_invalid http_status_code: 400 message: Reward every X friend actions must be a non negative number 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 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 reward_slots_out_of_range: summary: reward_slots_out_of_range value: code: reward_slots_out_of_range http_status_code: 400 message: Reward slot length must be between 1 and 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_type_not_found: summary: component_type_not_found value: code: component_type_not_found http_status_code: 400 message: Component type was not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_missing_type: summary: expression_missing_type value: code: expression_missing_type http_status_code: 400 message: Expression type missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_name_same_as_a_default_controller_name: summary: campaign_controller_name_same_as_a_default_controller_name value: code: campaign_controller_name_same_as_a_default_controller_name http_status_code: 400 message: Campaign controller name is the same as a default controller name 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 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 circular_component_reference: summary: circular_component_reference value: code: circular_component_reference http_status_code: 400 message: Circular campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_facets_not_found: summary: component_facets_not_found value: code: component_facets_not_found http_status_code: 400 message: Component facets not found 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_offset: summary: invalid_offset value: code: invalid_offset http_status_code: 400 message: Offset should be a non negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_misconfiguration: summary: controller_misconfiguration value: code: controller_misconfiguration http_status_code: 400 message: A controller is not properly configured parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_filename_length_out_of_range: summary: component_asset_filename_length_out_of_range value: code: component_asset_filename_length_out_of_range http_status_code: 400 message: Component Asset filename length is out of range 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 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 excessive_component_reference: summary: excessive_component_reference value: code: excessive_component_reference http_status_code: 400 message: Root campaign component may have at most one reference parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 duplicate_step_data_name: summary: duplicate_step_data_name value: code: duplicate_step_data_name http_status_code: 400 message: Step data name is duplicated parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_name_length_out_of_range: summary: step_data_name_length_out_of_range value: code: step_data_name_length_out_of_range http_status_code: 400 message: Step data name length is out of range. Max 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_key_invalid_length: summary: quality_rule_property_key_invalid_length value: code: quality_rule_property_key_invalid_length http_status_code: 400 message: Quality rule property keys must be between 2 and 24 characters 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 program_label_missing: summary: program_label_missing value: code: program_label_missing http_status_code: 403 message: Program label is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_too_long_expression: summary: campaign_controller_action_earn_reward_too_long_expression value: code: campaign_controller_action_earn_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2048 characters 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 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 campaign_label_name_contains_illegal_character: summary: campaign_label_name_contains_illegal_character value: code: campaign_label_name_contains_illegal_character http_status_code: 403 message: Campaign label name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_invalid_tags_length: summary: campaign_controller_action_earn_reward_invalid_tags_length value: code: campaign_controller_action_earn_reward_invalid_tags_length http_status_code: 400 message: Cumulative tags length can't be greater than 2048 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 creative_has_invalid_locale: summary: creative_has_invalid_locale value: code: creative_has_invalid_locale http_status_code: 400 message: Creative archive has an invalid locale parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_tags: summary: campaign_controller_action_earn_reward_missing_tags value: code: campaign_controller_action_earn_reward_missing_tags http_status_code: 400 message: At least one tag should be provided parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_archive_size_too_big: summary: creative_archive_size_too_big value: code: creative_archive_size_too_big http_status_code: 400 message: Submitted archive is greater than max allowed size parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_flow_path_missing: summary: campaign_flow_step_flow_path_missing value: code: campaign_flow_step_flow_path_missing http_status_code: 400 message: Flow path is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_unknown_classification: summary: creative_has_unknown_classification value: code: creative_has_unknown_classification http_status_code: 400 message: Unable to determine creative classification. Creative archive must contain one of the required render files 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 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 component_asset_filename_contains_illegal_character: summary: component_asset_filename_contains_illegal_character value: code: component_asset_filename_contains_illegal_character http_status_code: 400 message: Component asset filename can only contain alphanumeric, dash, period and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_attribute_value_out_of_range: summary: data_attribute_value_out_of_range value: code: data_attribute_value_out_of_range http_status_code: 400 message: Data attribute value length must not exceed 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 sibling_campaign_scheduled: summary: sibling_campaign_scheduled value: code: sibling_campaign_scheduled http_status_code: 400 message: Another campaign with same program label is already scheduled to start parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_path_invalid: summary: creative_asset_file_path_invalid value: code: creative_asset_file_path_invalid http_status_code: 400 message: Asset file path is invalid (not an URI or contains invalid characters) 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 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 campaign_global_rename: summary: campaign_global_rename value: code: campaign_global_rename http_status_code: 400 message: Global campaign renaming is restricted parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_label_name_missing: summary: campaign_label_name_missing value: code: campaign_label_name_missing http_status_code: 403 message: Campaign label name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 javascript_error: summary: javascript_error value: code: javascript_error http_status_code: 400 message: Error with archive's javascript parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_default_locale_disabled: summary: creative_has_default_locale_disabled value: code: creative_has_default_locale_disabled http_status_code: 400 message: Default locale must be in the list of enabled locales parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_after_stop_date: summary: date_after_stop_date value: code: date_after_stop_date http_status_code: 400 message: Date is after scheduled campaign stop date parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_filename_missing: summary: component_asset_filename_missing value: code: component_asset_filename_missing http_status_code: 400 message: Component Asset filename is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_type: summary: expression_invalid_type value: code: expression_invalid_type http_status_code: 400 message: Invalid expression type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_description_out_of_range: summary: campaign_component_description_out_of_range value: code: campaign_component_description_out_of_range http_status_code: 400 message: Campaign component description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_app_type_name_length_out_of_range: summary: campaign_flow_step_app_type_name_length_out_of_range value: code: campaign_flow_step_app_type_name_length_out_of_range http_status_code: 400 message: App type name length has to be between 1 and 255 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_flow_step_step_name_missing: summary: campaign_flow_step_step_name_missing value: code: campaign_flow_step_step_name_missing http_status_code: 400 message: Step name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 remove_start_date: summary: remove_start_date value: code: remove_start_date http_status_code: 400 message: Cannot remove start date for already started campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_content_length_out_of_range: summary: component_asset_content_length_out_of_range value: code: component_asset_content_length_out_of_range http_status_code: 400 message: Component Asset content size is out of range 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 campaign_controller_missing_event_trigger: summary: campaign_controller_missing_event_trigger value: code: campaign_controller_missing_event_trigger http_status_code: 400 message: A controller without enabled matching event trigger is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_already_used: summary: campaign_name_already_used value: code: campaign_name_already_used http_status_code: 403 message: Campaign name is already used by another campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_contains_illegal_character: summary: campaign_component_display_name_contains_illegal_character value: code: campaign_component_display_name_contains_illegal_character http_status_code: 400 message: Campaign component display name can only contain alphanumeric, dash, underscore, whitespace, asterisk, hash, dollar characters 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 campaign_flow_step_metric_description_length_out_of_range: summary: campaign_flow_step_metric_description_length_out_of_range value: code: campaign_flow_step_metric_description_length_out_of_range http_status_code: 400 message: Metric description length has to be between 1 and 2000 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_key_invalid_character: summary: quality_rule_property_key_invalid_character value: code: quality_rule_property_key_invalid_character http_status_code: 400 message: Quality rule property key can only contain alphanumeric, space, dash, colon and underscore parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_attribute_regexp_invalid: summary: data_attribute_regexp_invalid value: code: data_attribute_regexp_invalid http_status_code: 400 message: Data attribute value shoult be valid regexp parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_name_missing: summary: component_asset_name_missing value: code: component_asset_name_missing http_status_code: 400 message: Component Asset name is missing 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_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_value_since_month_invalid: summary: reward_value_since_month_invalid value: code: reward_value_since_month_invalid http_status_code: 400 message: Reward value since month must be 0-12 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reserved_name: summary: reserved_name value: code: reserved_name http_status_code: 400 message: Campaign frontend controller name is reserved parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_program_type: summary: invalid_program_type value: code: invalid_program_type http_status_code: 400 message: Invalid program type, length must be between 1 and 128 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_invalid_enabled_on_state: summary: campaign_controller_invalid_enabled_on_state value: code: campaign_controller_invalid_enabled_on_state http_status_code: 400 message: Invalid controller enabled on state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_out_of_range: summary: campaign_component_display_name_out_of_range value: code: campaign_component_display_name_out_of_range http_status_code: 400 message: Campaign component display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_size_too_big: summary: creative_asset_file_size_too_big value: code: creative_asset_file_size_too_big http_status_code: 400 message: Asset file size is greater than max allowed size parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference_socket_name: summary: invalid_component_reference_socket_name value: code: invalid_component_reference_socket_name http_status_code: 400 message: Invalid component reference socket name 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 backdated_start_date: summary: backdated_start_date value: code: backdated_start_date http_status_code: 400 message: Cannot set backdated start date 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 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 campaign_flow_step_metric_expression_missing: summary: campaign_flow_step_metric_expression_missing value: code: campaign_flow_step_metric_expression_missing http_status_code: 400 message: Metric expression is missing 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 component_asset_description_length_out_of_range: summary: component_asset_description_length_out_of_range value: code: component_asset_description_length_out_of_range http_status_code: 400 message: Component Asset description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_count_since_days_invalid: summary: reward_count_since_days_invalid value: code: reward_count_since_days_invalid http_status_code: 400 message: Reward count since days must be a non negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 program_label_not_found: summary: program_label_not_found value: code: program_label_not_found http_status_code: 403 message: Program label not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_not_found: summary: reward_supplier_not_found value: code: reward_supplier_not_found http_status_code: 403 message: Reward supplier not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_path_too_long: summary: creative_asset_file_path_too_long value: code: creative_asset_file_path_too_long http_status_code: 400 message: Asset file path length is greater than max allowed length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 transition_period_milliseconds_invalid: summary: transition_period_milliseconds_invalid value: code: transition_period_milliseconds_invalid http_status_code: 403 message: Transition period must be a positive long 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 campaign_controller_action_earn_reward_invalid_tag: summary: campaign_controller_action_earn_reward_invalid_tag value: code: campaign_controller_action_earn_reward_invalid_tag http_status_code: 400 message: Tag can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_reward_supplier: summary: campaign_controller_action_earn_reward_missing_reward_supplier value: code: campaign_controller_action_earn_reward_missing_reward_supplier http_status_code: 400 message: Reward supplier is required on launched campaigns parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_icon_type_length_out_of_range: summary: campaign_flow_step_icon_type_length_out_of_range value: code: campaign_flow_step_icon_type_length_out_of_range http_status_code: 400 message: Icon type length has to be between 1 and 64 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 quality_rule_property_key_unsupported: summary: quality_rule_property_key_unsupported value: code: quality_rule_property_key_unsupported http_status_code: 400 message: Quality rule property not supported for the quality rule type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_name_contains_illegal_character: summary: component_asset_name_contains_illegal_character value: code: component_asset_name_contains_illegal_character http_status_code: 400 message: Component asset name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_sequence_invalid: summary: campaign_flow_step_sequence_invalid value: code: campaign_flow_step_sequence_invalid http_status_code: 400 message: Flow step sequence has to be between 1 and 65535. 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 download_error: summary: download_error value: code: download_error http_status_code: 400 message: An error occurred downloading the creative archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_before_start_date: summary: date_before_start_date value: code: date_before_start_date http_status_code: 400 message: Date is before scheduled campaign start date parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_app_description_length_out_of_range: summary: campaign_flow_step_app_description_length_out_of_range value: code: campaign_flow_step_app_description_length_out_of_range http_status_code: 400 message: App description length has to be between 1 and 2000 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 action_count_invalid: summary: action_count_invalid value: code: action_count_invalid http_status_code: 400 message: Action count must be a positive integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_expression_length_out_of_range: summary: campaign_flow_step_metric_expression_length_out_of_range value: code: campaign_flow_step_metric_expression_length_out_of_range http_status_code: 400 message: Metric expression length has to be between 1 and 2000 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_word_length_out_of_range: summary: campaign_flow_step_word_length_out_of_range value: code: campaign_flow_step_word_length_out_of_range http_status_code: 400 message: Word length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_length: summary: quality_rule_property_value_invalid_length value: code: quality_rule_property_value_invalid_length http_status_code: 400 message: Quality rule property values must be between 2 and 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_country: summary: quality_rule_property_value_invalid_country value: code: quality_rule_property_value_invalid_country http_status_code: 400 message: Quality rule property value must only contain ISO 3166 country codes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_character: summary: quality_rule_property_value_invalid_character value: code: quality_rule_property_value_invalid_character http_status_code: 400 message: Quality rule property value can only contain alphanumeric, space, dash, colon and underscore parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_flow_path_invalid: summary: campaign_flow_step_flow_path_invalid value: code: campaign_flow_step_flow_path_invalid http_status_code: 400 message: Flow path has to match pattern /main_flow/sub_flow_1/sub_flow_2 etc parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_icon_color_length_out_of_range: summary: campaign_flow_step_icon_color_length_out_of_range value: code: campaign_flow_step_icon_color_length_out_of_range http_status_code: 400 message: Icon color length has to be between 1 and 64 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_campaign_json: summary: missing_campaign_json value: code: missing_campaign_json http_status_code: 403 message: Missing campaign.json file in campaign archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_frontend_controller_duplicate_controller: summary: campaign_frontend_controller_duplicate_controller value: code: campaign_frontend_controller_duplicate_controller http_status_code: 400 message: Two frontend controllers have the same unique key (controller name, journey name) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_archive_id: summary: invalid_archive_id value: code: invalid_archive_id http_status_code: 400 message: Creative archive not found for campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_out_of_range: summary: campaign_component_name_out_of_range value: code: campaign_component_name_out_of_range http_status_code: 400 message: Campaign component name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference: summary: invalid_component_reference value: code: invalid_component_reference http_status_code: 400 message: Unknown referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_invalid_regexp: summary: quality_rule_property_invalid_regexp value: code: quality_rule_property_invalid_regexp http_status_code: 400 message: Quality rule property value must be valid regular expression parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_type_validation_failed: summary: campaign_component_type_validation_failed value: code: campaign_component_type_validation_failed http_status_code: 400 message: Campaign component type validation failed 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 quality_rule_property_value_invalid_time_unit: summary: quality_rule_property_value_invalid_time_unit value: code: quality_rule_property_value_invalid_time_unit http_status_code: 400 message: Quality rule property value must be SECOND, MINUTE, HOUR, or DAY 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 program_type_empty: summary: program_type_empty value: code: program_type_empty http_status_code: 400 message: Program type cannot be empty or null parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_count_limit_invalid: summary: reward_count_limit_invalid value: code: reward_count_limit_invalid http_status_code: 400 message: Reward count limit must be a positive integer 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 not_found_page_forbidden_runtime_expressions: summary: not_found_page_forbidden_runtime_expressions value: code: not_found_page_forbidden_runtime_expressions http_status_code: 400 message: Frontend controller for not found page shouldn't use runtime expressions in the action parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_invalid_character_encoding: summary: creative_asset_invalid_character_encoding value: code: creative_asset_invalid_character_encoding http_status_code: 400 message: Asset file has invalid character encoding parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 non_marketing_state_change: summary: non_marketing_state_change value: code: non_marketing_state_change http_status_code: 400 message: Non-marketing campaigns cannot be paused or stopped parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_icon_type_missing: summary: campaign_flow_step_icon_type_missing value: code: campaign_flow_step_icon_type_missing http_status_code: 400 message: Icon type is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_step_data_value: summary: missing_step_data_value value: code: missing_step_data_value http_status_code: 400 message: Missing step data value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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_label_name_already_in_use: summary: campaign_label_name_already_in_use value: code: campaign_label_name_already_in_use http_status_code: 403 message: Campaign has already a label with this name 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 component_asset_name_duplicated: summary: component_asset_name_duplicated value: code: component_asset_name_duplicated http_status_code: 400 message: Component Asset with such name already exists, please specify an unique name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_id_missing: summary: campaign_component_id_missing value: code: campaign_component_id_missing http_status_code: 400 message: Campaign component id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_undefined_expression: summary: campaign_controller_action_earn_reward_undefined_expression value: code: campaign_controller_action_earn_reward_undefined_expression http_status_code: 400 message: Expression can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 identity_key_incompatible_usage: summary: identity_key_incompatible_usage value: code: identity_key_incompatible_usage http_status_code: 400 message: Non email Identity key cannot be used with reward every x friend actions reward rule 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 quality_rule_property_value_invalid_boolean: summary: quality_rule_property_value_invalid_boolean value: code: quality_rule_property_value_invalid_boolean http_status_code: 400 message: Quality rule property value must be true or false parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_step_data_name: summary: missing_step_data_name value: code: missing_step_data_name http_status_code: 400 message: Missing step data name 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 creative_is_missing_renderer: summary: creative_is_missing_renderer value: code: creative_is_missing_renderer http_status_code: 400 message: Creative archive is missing one of the required renderer files parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_component_reference: summary: invalid_external_component_reference value: code: invalid_external_component_reference http_status_code: 400 message: Unknown external referenced campaign component 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 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 quality_rule_property_value_invalid_number: summary: quality_rule_property_value_invalid_number value: code: quality_rule_property_value_invalid_number http_status_code: 400 message: Quality rule property value must be a number 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_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 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 campaign_not_found: summary: campaign_not_found value: code: campaign_not_found http_status_code: 404 message: Campaign not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_content_upload_error: summary: component_asset_content_upload_error value: code: component_asset_content_upload_error http_status_code: 400 message: Component Asset content failed to upload parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_too_many_journey_names: summary: campaign_controller_too_many_journey_names value: code: campaign_controller_too_many_journey_names http_status_code: 400 message: Too many journey names parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 name_contains_illegal_character: summary: name_contains_illegal_character value: code: name_contains_illegal_character http_status_code: 400 message: Name should contain alphanumeric, underscore, dash, dot and space characters only parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_app_name_missing: summary: campaign_flow_step_app_name_missing value: code: campaign_flow_step_app_name_missing http_status_code: 400 message: App name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_description_out_of_range: summary: campaign_description_out_of_range value: code: campaign_description_out_of_range http_status_code: 403 message: Campaign description length must be between 2 and 250 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_slots_concatenated_length_exception: summary: reward_slots_concatenated_length_exception value: code: reward_slots_concatenated_length_exception http_status_code: 400 message: Rewards slots concatenated length should be less than 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 not_found_page_invalid_action: summary: not_found_page_invalid_action value: code: not_found_page_invalid_action http_status_code: 400 message: Frontend controller for not found page must have only one action of display type with ALWAYS quality 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 campaign_global_archive: summary: campaign_global_archive value: code: campaign_global_archive http_status_code: 400 message: Global campaign archiving is restricted parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_tags_missing: summary: campaign_flow_step_metric_tags_missing value: code: campaign_flow_step_metric_tags_missing http_status_code: 400 message: Metric tags are missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_attribute_value_type_required: summary: data_attribute_value_type_required value: code: data_attribute_value_type_required http_status_code: 400 message: Data attribute value type is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_expression_type: summary: quality_rule_property_value_invalid_expression_type value: code: quality_rule_property_value_invalid_expression_type http_status_code: 400 message: 'Quality rule property value must be a valid expression type: [Lcom.extole.client.rest.campaign.incentive.reward.rule.ExpressionType' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_illegal_character: summary: campaign_name_illegal_character value: code: campaign_name_illegal_character http_status_code: 403 message: Campaign name can only contain alphanumeric, space, dash, parenthesis, slash, colon, comma, period, underscore, dollar and percentage parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_value_expression_length_out_of_range: summary: step_data_value_expression_length_out_of_range value: code: step_data_value_expression_length_out_of_range http_status_code: 400 message: Step data value expression length is out of range. Max 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_elements_cannot_have_multiple_references: summary: external_elements_cannot_have_multiple_references value: code: external_elements_cannot_have_multiple_references http_status_code: 400 message: External elements cannot have multiple references parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_name_out_of_range: summary: campaign_controller_name_out_of_range value: code: campaign_controller_name_out_of_range http_status_code: 400 message: Campaign controller name length must be between 2 and 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 min_cart_value_invalid: summary: min_cart_value_invalid value: code: min_cart_value_invalid http_status_code: 400 message: Minimum cart value must be a non negative number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_name_contains_illegal_character: summary: campaign_controller_name_contains_illegal_character value: code: campaign_controller_name_contains_illegal_character http_status_code: 400 message: Campaign controller name can only contain alphanumeric, dash and underscore characters 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 expression_missing_value: summary: expression_missing_value value: code: expression_missing_value http_status_code: 400 message: Expression value missing 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 reward_slots_invalid_name: summary: reward_slots_invalid_name value: code: reward_slots_invalid_name http_status_code: 400 message: Reward slot name should contain only characters, digits and '_','-' or , parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_temporal_unit: summary: quality_rule_property_value_invalid_temporal_unit value: code: quality_rule_property_value_invalid_temporal_unit http_status_code: 400 message: Quality rule property value must be SECONDS, MINUTES, HOURS or DAYS 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 invalid_theme_name: summary: invalid_theme_name value: code: invalid_theme_name http_status_code: 400 message: Invalid theme_name, length must be between 1 and 255 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 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 campaign_name_out_of_range: summary: campaign_name_out_of_range value: code: campaign_name_out_of_range http_status_code: 403 message: Campaign name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_is_missing: summary: campaign_name_is_missing value: code: campaign_name_is_missing http_status_code: 403 message: Campaign name is missing 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 quality_rule_property_invalid_value_count: summary: quality_rule_property_invalid_value_count value: code: quality_rule_property_invalid_value_count http_status_code: 400 message: Quality rule property can only have a single value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 backdated_stop_date: summary: backdated_stop_date value: code: backdated_stop_date http_status_code: 400 message: Cannot set backdated stop date parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_limit: summary: invalid_limit value: code: invalid_limit http_status_code: 400 message: Limit should be a non negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_reward_name_too_long: summary: campaign_controller_action_earn_reward_reward_name_too_long value: code: campaign_controller_action_earn_reward_reward_name_too_long http_status_code: 400 message: Reward name should not exceed 255 characters 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 campaign_tags_too_long: summary: campaign_tags_too_long value: code: campaign_tags_too_long http_status_code: 400 message: Tags length is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_name_missing: summary: campaign_controller_name_missing value: code: campaign_controller_name_missing http_status_code: 400 message: Campaign controller name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 variable_value_missing: summary: variable_value_missing value: code: variable_value_missing http_status_code: 400 message: Variable value missing 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 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 program_label_already_in_use: summary: program_label_already_in_use value: code: program_label_already_in_use http_status_code: 403 message: Program label already in use parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_is_missing_attributes: summary: creative_is_missing_attributes value: code: creative_is_missing_attributes http_status_code: 400 message: Creative archive is missing required attributes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_default_value_expression_length_out_of_range: summary: step_data_default_value_expression_length_out_of_range value: code: step_data_default_value_expression_length_out_of_range http_status_code: 400 message: Step data default value expression length is out of range. Max 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_description_length_out_of_range: summary: campaign_flow_step_description_length_out_of_range value: code: campaign_flow_step_description_length_out_of_range http_status_code: 400 message: Description length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 quality_rule_property_value_invalid_subnet: summary: quality_rule_property_value_invalid_subnet value: code: quality_rule_property_value_invalid_subnet http_status_code: 400 message: Quality rule property value must contain only valid subnetworks parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_name_length_out_of_range: summary: campaign_flow_step_metric_name_length_out_of_range value: code: campaign_flow_step_metric_name_length_out_of_range http_status_code: 400 message: Metric name length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_duplicate_controller: summary: campaign_controller_duplicate_controller value: code: campaign_controller_duplicate_controller http_status_code: 400 message: Two controllers have the same unique key (controller name, journey name) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 redundant_component_reference: summary: redundant_component_reference value: code: redundant_component_reference http_status_code: 400 message: Same reference defined multiple times parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_data_entry_name_out_of_range: summary: campaign_controller_action_earn_reward_data_entry_name_out_of_range value: code: campaign_controller_action_earn_reward_data_entry_name_out_of_range http_status_code: 400 message: Data entry name cannot be blank or exceed the maximum allowed length of 200 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_missing_journey_name: summary: campaign_controller_missing_journey_name value: code: campaign_controller_missing_journey_name http_status_code: 400 message: Missing journey name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 max_fetch_size_1000: summary: max_fetch_size_1000 value: code: max_fetch_size_1000 http_status_code: 400 message: Maximum allowed difference between limit and offset should be 1000 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 self_component_reference: summary: self_component_reference value: code: self_component_reference http_status_code: 400 message: Self campaign component reference is not allowed 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 reward_count_since_month_invalid: summary: reward_count_since_month_invalid value: code: reward_count_since_month_invalid http_status_code: 400 message: Reward count since month must be 0-12 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_app_type_name_missing: summary: campaign_flow_step_app_type_name_missing value: code: campaign_flow_step_app_type_name_missing http_status_code: 400 message: App type name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 action_type_already_exists: summary: action_type_already_exists value: code: action_type_already_exists http_status_code: 403 message: Transition rule action type already exists. Cannot duplicate parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_unit_length_out_of_range: summary: campaign_flow_step_metric_unit_length_out_of_range value: code: campaign_flow_step_metric_unit_length_out_of_range http_status_code: 400 message: Metric unit length has to be between 1 and 64 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_reward_supplier_id_not_found: summary: campaign_controller_action_earn_reward_reward_supplier_id_not_found value: code: campaign_controller_action_earn_reward_reward_supplier_id_not_found http_status_code: 400 message: Reward supplier not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_value_since_days_invalid: summary: reward_value_since_days_invalid value: code: reward_value_since_days_invalid http_status_code: 400 message: Reward value since days must be a non negative integer 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 campaign_flow_step_metric_expression_invalid: summary: campaign_flow_step_metric_expression_invalid value: code: campaign_flow_step_metric_expression_invalid http_status_code: 400 message: Metric expression is invalid 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 creative_mismatch_api_version: summary: creative_mismatch_api_version value: code: creative_mismatch_api_version http_status_code: 400 message: Creative mismatch api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_value_limit_invalid: summary: reward_value_limit_invalid value: code: reward_value_limit_invalid http_status_code: 400 message: Reward value limit must be a non negative number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_flow_path_length_out_of_range: summary: campaign_flow_step_flow_path_length_out_of_range value: code: campaign_flow_step_flow_path_length_out_of_range http_status_code: 400 message: Flow path length has to be between 2 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_global_type_change: summary: campaign_global_type_change value: code: campaign_global_type_change http_status_code: 400 message: Global campaign type must be CONFIGURATION parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_name_length_out_of_range: summary: component_asset_name_length_out_of_range value: code: component_asset_name_length_out_of_range http_status_code: 400 message: Component Asset name length is out of range 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 controller_name_length_out_of_range: summary: controller_name_length_out_of_range value: code: controller_name_length_out_of_range http_status_code: 400 message: Campaign frontend controller name is not of valid length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_asset_content_missing: summary: component_asset_content_missing value: code: component_asset_content_missing http_status_code: 400 message: Component Asset content is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 program_label_contains_illegal_character: summary: program_label_contains_illegal_character value: code: program_label_contains_illegal_character http_status_code: 403 message: Program label can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 orphan_external_component_reference: summary: orphan_external_component_reference value: code: orphan_external_component_reference http_status_code: 400 message: Orphan external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_duplicate_data_entry_name: summary: campaign_controller_action_earn_reward_duplicate_data_entry_name value: code: campaign_controller_action_earn_reward_duplicate_data_entry_name http_status_code: 400 message: Two data entry names evaluated to the same value 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 campaign_flow_step_app_type_missing: summary: campaign_flow_step_app_type_missing value: code: campaign_flow_step_app_type_missing http_status_code: 400 message: App type is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_installed_into_socket: summary: invalid_component_installed_into_socket value: code: invalid_component_installed_into_socket http_status_code: 400 message: Invalid component installed into socket parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 start_date_after_stop_date: summary: start_date_after_stop_date value: code: start_date_after_stop_date http_status_code: 400 message: Start date is after stop date parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_value_invalid_length: summary: expression_value_invalid_length value: code: expression_value_invalid_length http_status_code: 400 message: Expression value is not of valid length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_incompatible_api_version: summary: creative_has_incompatible_api_version value: code: creative_has_incompatible_api_version http_status_code: 400 message: Creative archive has an incompatible api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_contains_illegal_character: summary: campaign_component_name_contains_illegal_character value: code: campaign_component_name_contains_illegal_character http_status_code: 400 message: Campaign component name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_invalid_api_version: summary: creative_has_invalid_api_version value: code: creative_has_invalid_api_version http_status_code: 400 message: Creative archive has an invalid api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_is_referenced_by_active_configuration: summary: external_element_is_referenced_by_active_configuration value: code: external_element_is_referenced_by_active_configuration http_status_code: 400 message: External element is referenced by active configuration parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_unit_missing: summary: campaign_flow_step_metric_unit_missing value: code: campaign_flow_step_metric_unit_missing http_status_code: 400 message: Metric unit is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_invalid_tag: summary: campaign_invalid_tag value: code: campaign_invalid_tag http_status_code: 400 message: A tag contains invalid characters 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 upload_error: summary: upload_error value: code: upload_error http_status_code: 400 message: Error uploading archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_archive: summary: invalid_campaign_archive value: code: invalid_campaign_archive http_status_code: 403 message: Invalid campaign archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_metric_name_missing: summary: campaign_flow_step_metric_name_missing value: code: campaign_flow_step_metric_name_missing http_status_code: 400 message: Metric name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_already_in_use: summary: campaign_component_name_already_in_use value: code: campaign_component_name_already_in_use http_status_code: 400 message: Campaign component name is already used by another component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_value_invalid: summary: expression_value_invalid value: code: expression_value_invalid http_status_code: 400 message: Reward expression is not valid 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_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 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 campaign_label_name_out_of_range: summary: campaign_label_name_out_of_range value: code: campaign_label_name_out_of_range http_status_code: 403 message: Campaign label name is not of valid length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_step_alias: summary: invalid_step_alias value: code: invalid_step_alias http_status_code: 400 message: Invalid step alias parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_reward_name: summary: campaign_controller_action_earn_reward_missing_reward_name value: code: campaign_controller_action_earn_reward_missing_reward_name http_status_code: 400 message: Reward name is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_absolute_name_missing: summary: campaign_component_absolute_name_missing value: code: campaign_component_absolute_name_missing http_status_code: 400 message: Campaign component absolute name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_sequence_missing: summary: campaign_flow_step_sequence_missing value: code: campaign_flow_step_sequence_missing http_status_code: 400 message: Sequence is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_flow_step_app_name_length_out_of_range: summary: campaign_flow_step_app_name_length_out_of_range value: code: campaign_flow_step_app_name_length_out_of_range http_status_code: 400 message: App name length has to be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_attribute_name_out_of_range: summary: data_attribute_name_out_of_range value: code: data_attribute_name_out_of_range http_status_code: 400 message: Data attribute name length must not exceed 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 schemas: BuiltCampaignComponentVariableResponseAsCss: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CSS type: string type: object type: object ValueInBuiltJourneyKeyResponse: description: 'The value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value title: Static Value type: object - description: Handlebars expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: JourneyKeyContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: JourneyKeyContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignUnlockRequest: properties: lock_types: items: enum: - DUPLICATE - EDIT type: string type: array uniqueItems: true required: - lock_types type: object BuiltCampaignFlowStepResponse: properties: apps: items: $ref: '#/components/schemas/BuiltCampaignFlowStepAppResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: type: string flow_path: type: string flow_step_id: type: string icon_color: type: string icon_type: type: string metrics: items: $ref: '#/components/schemas/BuiltCampaignFlowStepMetricResponse' type: array name: type: string sequence: type: number step_name: type: string tags: items: type: string type: array uniqueItems: true words: $ref: '#/components/schemas/BuiltCampaignFlowStepWordsResponse' required: - apps - component_ids - component_references - description - flow_path - flow_step_id - icon_color - icon_type - metrics - name - sequence - step_name - tags - words type: object DataInCampaignControllerActionScheduleResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionSignalResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionSignalResponse' name: $ref: '#/components/schemas/NameInBuiltCampaignControllerActionSignalResponse' signal_polling_id: $ref: '#/components/schemas/SignalPollingIdInBuiltCampaignControllerActionSignalResponse' type: object required: - action_id - action_type - component_ids - component_references - data - enabled - name - quality - signal_polling_id type: object FilterScopeInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter scope enum: - CAMPAIGN - CLIENT - JOURNEY - PROGRAM title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterScope}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterScope');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string VariantSelectorInBuiltCampaignResponse: description: 'The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal variant selector title: Static Value - description: Handlebars expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: handlebars@runtime:{{variantSelector}} externalDocs: description: VariantSelectionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: javascript@runtime:function() { return context.get('variantSelector');} externalDocs: description: VariantSelectionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInBuiltCampaignControllerActionEarnRewardResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExpressionInExpressionSettingFilterResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' 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 CampaignResponse: description: Stored campaign definition. Fields `variant_selector` and `variants` are unevaluated and appear in buildtime-evaluatable form. properties: campaign_id: type: string campaign_locks: items: enum: - DUPLICATE - EDIT type: string type: array uniqueItems: true campaign_type: enum: - CONFIGURATION - EXTENSION - INTEGRATION - MARKETING type: string components: items: $ref: '#/components/schemas/CampaignComponentResponse' type: array description: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' flow_steps: items: $ref: '#/components/schemas/CampaignFlowStepResponse' type: array incentive: $ref: '#/components/schemas/IncentiveResponse' incentive_id: type: string is_published: type: boolean labels: items: $ref: '#/components/schemas/CampaignLabelResponse' type: array last_published_date: $ref: '#/components/schemas/ZonedDateTime' name: type: string parent_version: format: int32 nullable: true type: integer pause_date: $ref: '#/components/schemas/ZonedDateTime' program_label: type: string program_type: type: string start_date: $ref: '#/components/schemas/ZonedDateTime' state: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string steps: items: $ref: '#/components/schemas/CampaignStepResponse' type: array stop_date: $ref: '#/components/schemas/ZonedDateTime' tags: items: type: string type: array uniqueItems: true theme_name: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' variant_selector: $ref: '#/components/schemas/VariantSelectorInCampaignResponse' variants: $ref: '#/components/schemas/VariantsInCampaignResponse' version: format: int32 type: integer required: - campaign_id - campaign_locks - campaign_type - components - description - end_date - flow_steps - incentive - incentive_id - is_published - labels - last_published_date - name - parent_version - pause_date - program_label - program_type - start_date - state - steps - stop_date - tags - theme_name - updated_date - variant_selector - variants - version type: object BuiltComponentClientKeyFlowVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: authorization_url: type: string client_secret_key_id: type: string description: type: string redirect_url: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_KEY_FLOW type: string type: object required: - authorization_url - client_secret_key_id - description - display_name - name - priority - redirect_url - source - source_component_id - source_version - tags - type - values type: object CampaignComponentFacetResponse: properties: name: type: string value: type: string type: object ResponseInCampaignControllerActionDisplayResponse: description: 'The response as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Literal response title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{response}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('response');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignFlowStepAppTypeResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 ExtraDataInBuiltCampaignControllerActionEarnRewardResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string JourneyNameInCampaignJourneyEntryResponse: description: 'The journey name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal journey name title: Static Value - 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:{{journeyName}} 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('journeyName');} 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 NameInCampaignControllerActionSignalResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionCreateMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CREATE_MEMBERSHIP type: string audience_id: type: string type: object required: - action_id - action_type - audience_id - component_ids - component_references - enabled - quality type: object CampaignComponentResponse: description: Stored campaign component definition. Field `display_name` is unevaluated and appears in buildtime-evaluatable form. properties: assets: items: $ref: '#/components/schemas/ComponentAssetResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' description: type: string display_name: $ref: '#/components/schemas/DisplayNameInCampaignComponentResponse' facets: items: $ref: '#/components/schemas/CampaignComponentFacetResponse' type: array id: readOnly: true type: string install: $ref: '#/components/schemas/InstallInCampaignComponentResponse' installed_into_socket: type: string name: type: string origin: $ref: '#/components/schemas/ComponentOriginResponse' tags: items: type: string type: array uniqueItems: true type: type: string types: items: type: string type: array updated_date: $ref: '#/components/schemas/ZonedDateTime' upload_version: type: string variables: items: $ref: '#/components/schemas/CampaignComponentSettingResponse' type: array version: format: int32 type: integer required: - assets - component_ids - component_references - created_date - description - display_name - facets - id - install - installed_into_socket - name - origin - tags - type - types - updated_date - upload_version - variables - version type: object BuiltCampaignStepResponse: discriminator: mapping: CONTROLLER: '#/components/schemas/BuiltCampaignControllerResponse' FRONTEND_CONTROLLER: '#/components/schemas/BuiltCampaignFrontendControllerResponse' JOURNEY_ENTRY: '#/components/schemas/BuiltCampaignJourneyEntryResponse' propertyName: type oneOf: - $ref: '#/components/schemas/BuiltCampaignControllerResponse' - $ref: '#/components/schemas/BuiltCampaignFrontendControllerResponse' - $ref: '#/components/schemas/BuiltCampaignJourneyEntryResponse' required: - component_ids - component_references - created_date - data - enabled - id - step_builder - triggers - type - updated_date DelaysInBuiltCampaignControllerActionScheduleResponse: description: 'The delays as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerAccessResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - ACCESS type: string trusted_scopes: items: enum: - BACKEND - CLIENT_ADMIN - CLIENT_REPORT_DOWNLOAD - CLIENT_SUPERUSER - ONE_TIME - PASSWORD_RESET - UPDATE_PROFILE - USER_SUPPORT - VERIFIED_CONSUMER type: string type: array uniqueItems: true type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type - trusted_scopes type: object ScheduleNameInCampaignControllerActionScheduleResponse: description: 'The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal schedule name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{scheduleName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('scheduleName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableResponse: description: 'The captured setting values description as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal captured setting values description title: Static Value - 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:{{capturedSettingValuesDescription}} 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('capturedSettingValuesDescription');} 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 CampaignPublishRequest: properties: launch: nullable: true type: boolean message: nullable: true type: string required: - launch - message type: object MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The message as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal message title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInCampaignControllerActionEarnRewardResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionIncentivizeResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_name: type: string action_type: enum: - INCENTIVIZE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeResponse' incentivize_action_type: $ref: '#/components/schemas/IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse' overrides: additionalProperties: type: string type: object review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeResponse' type: object type: object ScopeInCampaignFrontendControllerResponse: description: 'The scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal scope enum: - CLIENT - PRIVATE - PUBLIC 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:{{scope}} 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('scope');} 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 DataInBuiltCampaignControllerActionEmailResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentPartnerEnumVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - PARTNER_ENUM type: string 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 webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignComponentPartnerEnumVariableResponse' options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object description: Stored campaign component partner enum variable definition. Fields `description` and `webhook_id` are unevaluated and appear in buildtime-evaluatable form. required: - description - display_name - name - options - priority - source - tags - type - values - webhook_id type: object SingularNounNameInCampaignFlowStepWordsResponse: description: 'The singular noun name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal singular noun name title: Static Value - description: Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: handlebars@buildtime:{{singularNounName}} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('singularNounName');} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ScheduleNameInBuiltCampaignControllerActionScheduleResponse: description: 'The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal schedule name title: Static Value - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentVariableResponseAsClientDomainIdList: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - CLIENT_DOMAIN_ID_LIST type: string 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 type: object NameInCampaignControllerResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 BuiltCampaignComponentVariableResponseAsStringList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING_LIST type: string type: object type: object SumOfValueMaxInCampaignControllerTriggerHasPriorStepResponse: description: 'The sum of value max as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal sum of value max title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{sumOfValueMax}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('sumOfValueMax');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardActionIdInCampaignControllerActionEarnRewardResponse: description: 'The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward action id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltComponentEnumListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ENUM_LIST type: string type: object required: - allowed_values - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object EventNamesInCampaignControllerTriggerRewardEventResponse: description: 'The event names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionCreativeResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CREATIVE type: string api_version: format: int32 type: integer build_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string has_creative: type: boolean latest_version: format: int32 type: integer theme_version: type: string type: object required: - action_id - action_type - api_version - build_version - classification - component_ids - component_references - enabled - has_creative - latest_version - quality - theme_version type: object ExtraDataInCampaignControllerActionScheduleResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignFlowStepAppResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 ExtraDataInCampaignControllerActionEarnRewardResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInBuiltCampaignControllerTriggerAudienceMembershipResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: AudienceMembershipTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: AudienceMembershipTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExpressionInBuiltCampaignControllerActionExpressionResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal expression title: Static Value type: object - description: Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltComponentRewardSupplierIdListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_reward_supplier_ids: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - REWARD_SUPPLIER_ID_LIST type: string type: object required: - allowed_reward_supplier_ids - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object BuiltCampaignControllerActionDeclineResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DECLINE type: string cause_type: type: string event_type: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string type: object required: - action_id - action_type - cause_type - component_ids - component_references - enabled - event_type - legacy_action_id - note - partner_event_id - polling_id - polling_name - quality type: object CampaignComponentSettingResponseBase: properties: description: $ref: '#/components/schemas/DescriptionInCampaignComponentSettingResponseBase' 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_SETTING_LOOKUP - CSS - 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 - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string type: object CampaignComponentVariableResponseAsColor: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - COLOR type: string 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 type: object BuiltCampaignControllerTriggerMaxMindResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: allow_high_risk_email: type: boolean default_quality_score: enum: - ERROR - HIGH - LOW type: string ip_threshold: format: int64 type: integer risk_threshold: format: int64 type: integer trigger_type: enum: - MAXMIND type: string type: object required: - allow_high_risk_email - component_ids - component_references - default_quality_score - enabled - ip_threshold - negated - parent_trigger_group_name - risk_threshold - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object FilterMinDateInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal filter min date title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMinDate}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMinDate');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsAdminIcon: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - ADMIN_ICON type: string 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 type: object CampaignControllerTriggerEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: event_names: $ref: '#/components/schemas/EventNamesInCampaignControllerTriggerEventResponse' event_type: $ref: '#/components/schemas/EventTypeInCampaignControllerTriggerEventResponse' trigger_type: enum: - EVENT type: string type: object type: object BuiltCampaignFlowStepAppResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: type: string name: type: string type: $ref: '#/components/schemas/BuiltCampaignFlowStepAppTypeResponse' required: - component_ids - component_references - description - name - type type: object ScopeInCampaignControllerResponse: description: 'The scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal scope enum: - CLIENT - PRIVATE - PUBLIC 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:{{scope}} 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('scope');} 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 EnabledInCampaignControllerActionResponseBase: description: 'The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignLabelResponse: properties: name: type: string type: enum: - DATA - PROGRAM type: string type: object BuiltCampaignControllerTriggerStepEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array uniqueItems: true having_any_data_name: items: type: string type: array uniqueItems: true trigger_type: enum: - STEP_EVENT type: string type: object type: object FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse: description: 'The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter expression title: Static Value type: boolean - description: Handlebars expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterExpression}} externalDocs: description: StepHasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterExpression');} externalDocs: description: StepHasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentVariableResponse: properties: description: $ref: '#/components/schemas/DescriptionInCampaignComponentVariableResponse' display_name: type: string name: type: string priority: $ref: '#/components/schemas/DeweyDecimal' source: enum: - INHERITED - LOCAL - PARAMETER type: string 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_SETTING_LOOKUP - CSS - 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 - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string values: $ref: '#/components/schemas/ComponentSettingVariableValues' type: object SumOfFaceValueMaxInCampaignControllerTriggerHasPriorRewardResponse: description: 'The sum of face value max as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal sum of face value max title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{sumOfFaceValueMax}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('sumOfFaceValueMax');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string Instant: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.' example: '2025-10-24T09:00:00.000Z' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$ type: string EventTimeInCampaignControllerActionEarnRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDeclineResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DECLINE type: string cause_type: type: string event_type: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string type: object type: object BuiltCampaignControllerTriggerClientDomainResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: client_domain_ids: items: type: string type: array uniqueItems: true trigger_type: enum: - CLIENT_DOMAIN type: string type: object required: - client_domain_ids - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object SlotsInBuiltCampaignControllerActionEarnRewardResponse: description: 'The slots as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The event type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DefaultInComponentSettingVariableValues: 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 PersonIdInCampaignControllerTriggerHasPriorStepResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionDataIntelligenceResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DATA_INTELLIGENCE type: string event_name: type: string intelligence_provider: enum: - EMAIL_AGE - MAXMIND - NOOP type: string profile_risk_update_interval: $ref: '#/components/schemas/Duration' type: object required: - action_id - action_type - component_ids - component_references - enabled - event_name - intelligence_provider - profile_risk_update_interval - quality type: object RewardTagsInBuiltCampaignControllerActionApproveResponse: description: 'The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string 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' DescriptionInCampaignFlowStepMetricResponse: description: 'The description as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal description nullable: true title: Static Value type: string - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CountMaxInCampaignControllerTriggerHasPriorStepResponse: description: 'The count max as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count max format: int32 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMax}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMax');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentEnumVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - ENUM type: string 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 enum variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - allowed_values - description - display_name - name - priority - source - tags - type - values type: object TargetingAttributesInCampaignControllerTriggerEventTargetingResponse: description: 'The targeting attributes as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: string description: Literal targeting attributes title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{targetingAttributes}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('targetingAttributes');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: scope: enum: - CAMPAIGN - JOURNEY - PROGRAM type: string trigger_type: enum: - TARGETING type: string type: object type: object PersonIdInCampaignControllerTriggerJourneyCheckResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{personId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: StepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: StepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FilterMaxValueInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter max value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter max value title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMaxValue}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMaxValue');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentComponentSettingLookupVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: capture_settings: items: type: string type: array captured_setting_values_description: $ref: '#/components/schemas/CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableResponse' filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array matching_filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - COMPONENT_SETTING_LOOKUP type: string 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 setting lookup variable definition. Fields `description` and `captured_setting_values_description` are unevaluated and appear in buildtime-evaluatable form. required: - capture_settings - captured_setting_values_description - description - display_name - filters - matching_filters - name - priority - source - tags - type - values type: object CampaignControllerActionCreativeResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CREATIVE type: string api_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string has_creative: type: boolean latest_version: format: int32 type: integer output: additionalProperties: items: type: string type: array type: object theme_version: type: string type: object type: object BuiltCampaignComponentVariableResponseAsUrl: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - URL type: string type: object type: object DataInCampaignControllerActionWebhookResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentVariableResponseAsGlobComponentPath: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - GLOB_COMPONENT_PATH type: string 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 type: object DataInBuiltCampaignControllerActionSignalResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerTriggerHasPriorRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: count_matches: $ref: '#/components/schemas/CountMatchesInCampaignControllerTriggerHasPriorRewardResponse' count_max: $ref: '#/components/schemas/CountMaxInCampaignControllerTriggerHasPriorRewardResponse' count_min: $ref: '#/components/schemas/CountMinInCampaignControllerTriggerHasPriorRewardResponse' filter_expression: $ref: '#/components/schemas/FilterExpressionInCampaignControllerTriggerHasPriorRewardResponse' filter_expressions: items: type: string type: array uniqueItems: true filter_face_value_types: $ref: '#/components/schemas/FilterFaceValueTypesInCampaignControllerTriggerHasPriorRewardResponse' filter_max_age: $ref: '#/components/schemas/FilterMaxAgeInCampaignControllerTriggerHasPriorRewardResponse' filter_max_date: $ref: '#/components/schemas/FilterMaxDateInCampaignControllerTriggerHasPriorRewardResponse' filter_min_age: $ref: '#/components/schemas/FilterMinAgeInCampaignControllerTriggerHasPriorRewardResponse' filter_min_date: $ref: '#/components/schemas/FilterMinDateInCampaignControllerTriggerHasPriorRewardResponse' filter_names: $ref: '#/components/schemas/FilterNamesInCampaignControllerTriggerHasPriorRewardResponse' filter_reward_supplier_ids: $ref: '#/components/schemas/FilterRewardSupplierIdsInCampaignControllerTriggerHasPriorRewardResponse' filter_scope: $ref: '#/components/schemas/FilterScopeInCampaignControllerTriggerHasPriorRewardResponse' filter_states: $ref: '#/components/schemas/FilterStatesInCampaignControllerTriggerHasPriorRewardResponse' filter_tags: $ref: '#/components/schemas/FilterTagsInCampaignControllerTriggerHasPriorRewardResponse' sum_of_face_value_max: $ref: '#/components/schemas/SumOfFaceValueMaxInCampaignControllerTriggerHasPriorRewardResponse' sum_of_face_value_min: $ref: '#/components/schemas/SumOfFaceValueMinInCampaignControllerTriggerHasPriorRewardResponse' tax_year_start: $ref: '#/components/schemas/TaxYearStartInCampaignControllerTriggerHasPriorRewardResponse' trigger_type: enum: - HAS_PRIOR_REWARD type: string type: object type: object DataMapInCampaignControllerActionEarnRewardResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEarnRewardResponse' type: object DataMapInBuiltCampaignControllerActionExpressionResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionExpressionResponse' type: object FilterRewardSupplierIdsInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter reward supplier ids items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterRewardSupplierIds}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterRewardSupplierIds');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionEmailResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string StepBuilderInCampaignStepResponseBase: description: 'The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal step builder title: Static Value type: object - 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:{{stepBuilder}} 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('stepBuilder');} 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 - description: Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: handlebars@runtime:{{stepBuilder}} externalDocs: description: StepBuilderContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: javascript@runtime:function() { return context.get('stepBuilder');} externalDocs: description: StepBuilderContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object NameInStepDataResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 BuiltCampaignControllerTriggerGroupResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: operator: enum: - AND - OR type: string trigger_type: enum: - GROUP type: string type: object type: object PersonIdInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CountMinInCampaignControllerTriggerHasPriorStepResponse: description: 'The count min as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count min format: int32 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMin}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMin');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionFulfillRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - FULFILL_REWARD type: string message: type: string partner_reward_id: $ref: '#/components/schemas/PartnerRewardIdInBuiltCampaignControllerActionFulfillRewardResponse' reward_id: type: string success: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - partner_reward_id - quality - reward_id - success type: object ActionTypeInCampaignControllerTriggerLegacyQualityResponse: description: 'The action type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal action type enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{actionType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('actionType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DefaultQualityScoreInCampaignControllerTriggerMaxMindResponse: description: 'The default quality score as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal default quality score enum: - ERROR - HIGH - LOW title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{defaultQualityScore}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('defaultQualityScore');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string InstallInCampaignComponentResponse: description: 'The install as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal install title: Static Value type: object - description: Handlebars expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: handlebars@installtime:{{install}} externalDocs: description: ComponentInstalltimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^handlebars@installtime:.* title: Installtime - Handlebars type: string - description: Javascript expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: javascript@installtime:function() { return context.getVariableContext().get('install');} externalDocs: description: ComponentInstalltimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^javascript@installtime:.* title: Installtime - Javascript type: string ZoneNameInCampaignControllerActionEmailResponse: description: 'The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal zone name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{zoneName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('zoneName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentStringMapVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: allowed_keys: items: type: string type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - STRING_MAP type: string 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 string map variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - allowed_keys - description - display_name - name - priority - source - tags - type - values type: object BuiltCampaignControllerTriggerReferredByEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: referral_originator: enum: - ADVOCATE - FRIEND nullable: true type: string trigger_type: enum: - REFERRED_BY_EVENT type: string type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - referral_originator - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object CampaignProgramUpdateRequest: description: Body of a `PUT /v2/campaigns/program/{program_label}/update` request. properties: program_type: type: string required: - program_type type: object FireAsPersonIdentificationBase: properties: person_identification_type: enum: - EMAIL - PARTNER_EVENT_ID - PARTNER_USER_ID - PERSON_ID type: string value: type: string type: object CampaignComponentVariableResponseAsFont: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - FONT type: string 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 type: object SendPolicyInCampaignControllerResponse: description: 'The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal send policy enum: - ALL - FIRST_ONLY 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:{{sendPolicy}} 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('sendPolicy');} 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 PartnerRewardIdInBuiltCampaignControllerActionFulfillRewardResponse: description: 'The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner reward id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentComponentIdVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: filter: $ref: '#/components/schemas/ComponentIdFilterResponse' source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - COMPONENT_ID type: string 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 id variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - description - display_name - filter - name - priority - source - tags - type - values type: object CountMinInCampaignControllerTriggerHasPriorRewardResponse: description: 'The count min as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count min format: int32 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMin}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMin');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string StepBuilderInBuiltCampaignStepResponseBase: description: 'The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal step builder title: Static Value type: object - description: Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: handlebars@runtime:{{stepBuilder}} externalDocs: description: StepBuilderContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: javascript@runtime:function() { return context.get('stepBuilder');} externalDocs: description: StepBuilderContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal review status title: Static Value - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SlotsInCampaignControllerTriggerRewardEventResponse: description: 'The slots as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{slots}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('slots');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledOnStatesInCampaignFrontendControllerResponse: description: 'The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled on states items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string title: Static Value type: array uniqueItems: true - 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:{{enabledOnStates}} 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('enabledOnStates');} 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 CampaignControllerTriggerMaxMindResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: allow_high_risk_email: $ref: '#/components/schemas/AllowHighRiskEmailInCampaignControllerTriggerMaxMindResponse' default_quality_score: $ref: '#/components/schemas/DefaultQualityScoreInCampaignControllerTriggerMaxMindResponse' ip_threshold: $ref: '#/components/schemas/IpThresholdInCampaignControllerTriggerMaxMindResponse' risk_threshold: $ref: '#/components/schemas/RiskThresholdInCampaignControllerTriggerMaxMindResponse' trigger_type: enum: - MAXMIND type: string type: object type: object ComponentIdFilterResponse: properties: component_types: items: type: string type: array uniqueItems: true type: object BuiltCampaignComponentVariableResponseAsColor: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COLOR type: string type: object type: object MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The move to pending as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal move to pending title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{moveToPending}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('moveToPending');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdInCampaignControllerActionRemoveMembershipResponse: description: 'The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal audience id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerTriggerLegacyQualityResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: action_type: $ref: '#/components/schemas/ActionTypeInCampaignControllerTriggerLegacyQualityResponse' trigger_type: enum: - LEGACY_QUALITY type: string type: object type: object FireAsPersonJourney: properties: advocate_code: type: string advocate_partner_user_id: type: string campaign_id: type: string container: type: string coupon_code: type: string journey_type: type: string label: type: string promotable_code: type: string reason: type: string referral_reason: enum: - ADVOCATE - ADVOCATE_CODE - ADVOCATE_PARTNER_USER_ID - COUPON_CODE - DISPLACED_PARTNER_USER_ID - INCENTIVIZED_SHARE - PARTNER_EVENT_ID - PARTNER_SHARE_ID - SHAREABLE_ID - SHARE_ID - SHARE_RECIPIENT - UNKNOWN_REASON type: string share_id: type: string shareable_id: type: string zone: type: string type: object CampaignFlowStepResponse: description: Stored campaign flow step definition. Fields `flow_path`, `sequence`, `step_name`, `icon_type`, `tags`, `name`, `icon_color`, and `description` are unevaluated and appear in buildtime-evaluatable form. properties: apps: items: $ref: '#/components/schemas/CampaignFlowStepAppResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepResponse' flow_path: $ref: '#/components/schemas/FlowPathInCampaignFlowStepResponse' flow_step_id: type: string icon_color: $ref: '#/components/schemas/IconColorInCampaignFlowStepResponse' icon_type: $ref: '#/components/schemas/IconTypeInCampaignFlowStepResponse' metrics: items: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' type: array name: $ref: '#/components/schemas/NameInCampaignFlowStepResponse' sequence: $ref: '#/components/schemas/SequenceInCampaignFlowStepResponse' step_name: $ref: '#/components/schemas/StepNameInCampaignFlowStepResponse' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepResponse' words: $ref: '#/components/schemas/CampaignFlowStepWordsResponse' required: - apps - component_ids - component_references - description - flow_path - flow_step_id - icon_color - icon_type - metrics - name - sequence - step_name - tags - words type: object CampaignControllerActionRemoveMembershipResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REMOVE_MEMBERSHIP type: string audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionRemoveMembershipResponse' type: object type: object FilterMaxDateInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter max date as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal filter max date title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMaxDate}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMaxDate');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsDelayList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - DELAY_LIST type: string type: object type: object PersonCountingNameInCampaignFlowStepWordsResponse: description: 'The person counting name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal person counting name title: Static Value - description: Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: handlebars@buildtime:{{personCountingName}} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personCountingName');} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionWebhookResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - WEBHOOK type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionWebhookResponse' webhook_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - quality - webhook_id type: object ScopeInStepDataResponse: description: 'The scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal scope enum: - CLIENT - PRIVATE - PUBLIC 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:{{scope}} 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('scope');} 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 FilterProgramLabelsInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter program labels items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterProgramLabels}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterProgramLabels');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterProgramLabels}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterProgramLabels');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionRevokeRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REVOKE_REWARD type: string message: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - quality - reward_id type: object CampaignControllerActionCancelRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CANCEL_REWARD type: string message: type: string reward_id: type: string type: object type: object CampaignControllerTriggerStickyJourneyResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: label: $ref: '#/components/schemas/LabelInCampaignControllerTriggerStickyJourneyResponse' trigger_type: enum: - STICKY_JOURNEY type: string type: object type: object SlotsInCampaignControllerActionEarnRewardResponse: description: 'The slots as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{slots}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('slots');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerAudienceMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: having_any_audience_id: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInBuiltCampaignControllerTriggerAudienceMembershipResponse' trigger_type: enum: - AUDIENCE_MEMBERSHIP type: string type: object required: - component_ids - component_references - enabled - having_any_audience_id - negated - parent_trigger_group_name - person_id - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse: description: 'The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter program labels items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterProgramLabels}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterProgramLabels');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionIncentivizeResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeResponse' type: object CampaignControllerActionResponse: description: Stored campaign controller action definition. Field `enabled` is unevaluated and appears in buildtime-evaluatable form. discriminator: mapping: APPROVE: '#/components/schemas/CampaignControllerActionApproveResponse' CANCEL_REWARD: '#/components/schemas/CampaignControllerActionCancelRewardResponse' CREATE_MEMBERSHIP: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' CREATIVE: '#/components/schemas/CampaignControllerActionCreativeResponse' DATA_INTELLIGENCE: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' DECLINE: '#/components/schemas/CampaignControllerActionDeclineResponse' DISPLAY: '#/components/schemas/CampaignControllerActionDisplayResponse' EARN_REWARD: '#/components/schemas/CampaignControllerActionEarnRewardResponse' EMAIL: '#/components/schemas/CampaignControllerActionEmailResponse' EXPRESSION: '#/components/schemas/CampaignControllerActionExpressionResponse' FIRE_AS_PERSON: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' FULFILL_REWARD: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' INCENTIVIZE: '#/components/schemas/CampaignControllerActionIncentivizeResponse' INCENTIVIZE_STATUS_UPDATE: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' REDEEM_REWARD: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' REMOVE_MEMBERSHIP: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' REVOKE_REWARD: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' SCHEDULE: '#/components/schemas/CampaignControllerActionScheduleResponse' SHARE_EVENT: '#/components/schemas/CampaignControllerActionShareEventResponse' SIGNAL: '#/components/schemas/CampaignControllerActionSignalResponse' SIGNAL_V1: '#/components/schemas/CampaignControllerActionSignalV1Response' STEP_SIGNAL: '#/components/schemas/CampaignControllerActionStepSignalResponse' WEBHOOK: '#/components/schemas/CampaignControllerActionWebhookResponse' propertyName: action_type oneOf: - $ref: '#/components/schemas/CampaignControllerActionApproveResponse' - $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' - $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' - $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' - $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' - $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' - $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionEmailResponse' - $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' - $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' - $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' - $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' - $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' - $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' - $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' - $ref: '#/components/schemas/CampaignControllerActionSignalResponse' - $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' - $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' - $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' required: - action_id - action_type - component_ids - component_references - enabled - quality PartnerEventIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: partner_event_key: type: string person_identification_type: enum: - PARTNER_EVENT_ID type: string type: object type: object TriggerDescriptionInCampaignControllerTriggerResponseBase: description: 'The trigger description as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal trigger description title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{triggerDescription}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('triggerDescription');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FilterMaxAgeInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter max age as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Duration' description: Literal filter max age title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMaxAge}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMaxAge');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInCampaignFlowStepAppResponse: description: 'The description as configured: a literal value, or an expression (type:string) when defined dynamically.' 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 HavingAnyDataNameInCampaignControllerTriggerStepEventResponse: description: 'The having any data name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal having any data name items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{havingAnyDataName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('havingAnyDataName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsIntegerList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - INTEGER_LIST type: string type: object type: object CampaignVersionDescriptionResponse: properties: created_date: $ref: '#/components/schemas/ZonedDateTime' editor_id: type: string editor_type: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' last_published_date: $ref: '#/components/schemas/ZonedDateTime' message: type: string parent_version: type: string pause_date: $ref: '#/components/schemas/ZonedDateTime' published_date: $ref: '#/components/schemas/ZonedDateTime' start_date: $ref: '#/components/schemas/ZonedDateTime' stop_date: $ref: '#/components/schemas/ZonedDateTime' user_id: type: string version: type: string required: - created_date - editor_id - editor_type - end_date - last_published_date - message - parent_version - pause_date - published_date - start_date - stop_date - user_id - version type: object FormDataContentDisposition: properties: creationDate: format: date-time type: string fileName: type: string modificationDate: format: date-time type: string name: type: string parameters: additionalProperties: type: string type: object readDate: format: date-time type: string size: format: int64 type: integer type: type: string type: object DataMapInCampaignControllerActionFireAsPersonResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionFireAsPersonResponse' type: object CountMatchesInCampaignControllerTriggerHasPriorStepResponse: description: 'The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count matches items: format: int32 type: integer title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMatches}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMatches');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsAudienceId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - AUDIENCE_ID type: string type: object type: object DataInCampaignControllerActionEarnRewardResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTimeInCampaignControllerActionFireAsPersonResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal event time title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventTime}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventTime');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionSignalV1Response: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL_V1 type: string data: additionalProperties: type: string type: object signal_polling_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - quality - signal_polling_id type: object DescriptionInCampaignFlowStepResponse: description: 'The description as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal description nullable: true title: Static Value type: string - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse: description: 'The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter campaign ids items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterCampaignIds}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterCampaignIds');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignFlowStepWordsResponse: properties: person_counting_name: $ref: '#/components/schemas/PersonCountingNameInCampaignFlowStepWordsResponse' plural_noun_name: $ref: '#/components/schemas/PluralNounNameInCampaignFlowStepWordsResponse' rate_name: $ref: '#/components/schemas/RateNameInCampaignFlowStepWordsResponse' singular_noun_name: $ref: '#/components/schemas/SingularNounNameInCampaignFlowStepWordsResponse' verb_name: $ref: '#/components/schemas/VerbNameInCampaignFlowStepWordsResponse' type: object CampaignControllerTriggerExpressionResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: data: additionalProperties: type: string nullable: true type: object expression: $ref: '#/components/schemas/ExpressionInCampaignControllerTriggerExpressionResponse' trigger_type: enum: - EXPRESSION type: string type: object type: object ComponentSettingVariableValues: 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/DefaultInComponentSettingVariableValues' en: $ref: '#/components/schemas/EnInComponentSettingVariableValues' type: object BuiltCampaignComponentVariableResponseAsString: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING type: string type: object type: object JourneyNamesInCampaignControllerResponse: description: 'The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal journey names items: type: string title: Static Value type: array uniqueItems: true - 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:{{journeyNames}} 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('journeyNames');} 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 AudienceIdInCampaignControllerActionCreateMembershipResponse: description: 'The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal audience id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsWebhookId: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - WEBHOOK_ID type: string 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 type: object EnInComponentSettingVariableValues: 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 FilterScopeInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter scope enum: - ATTRIBUTED - CAMPAIGN - CLIENT - JOURNEY - PROGRAM title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterScope}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterScope');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignScheduleRequest: properties: end_date: $ref: '#/components/schemas/ZonedDateTime' pause_date: $ref: '#/components/schemas/ZonedDateTime' start_date: $ref: '#/components/schemas/ZonedDateTime' stop_date: $ref: '#/components/schemas/ZonedDateTime' type: object DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeStatusUpdateResponse' type: object BuiltCampaignControllerActionRedeemRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REDEEM_REWARD type: string data: additionalProperties: type: string type: object partner_event_id: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - partner_event_id - quality - reward_id type: object RewardNamesInCampaignControllerTriggerSendRewardEventResponse: description: 'The reward names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignLockRequest: properties: lock_types: items: enum: - DUPLICATE - EDIT type: string type: array uniqueItems: true required: - lock_types type: object BuiltCampaignControllerTriggerResponse: discriminator: mapping: ACCESS: '#/components/schemas/BuiltCampaignControllerTriggerAccessResponse' AUDIENCE_MEMBERSHIP: '#/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipResponse' AUDIENCE_MEMBERSHIP_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipEventResponse' CLIENT_DOMAIN: '#/components/schemas/BuiltCampaignControllerTriggerClientDomainResponse' DATA_INTELLIGENCE_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerDataIntelligenceEventResponse' EVENT: '#/components/schemas/BuiltCampaignControllerTriggerEventResponse' EVENT_TARGETING: '#/components/schemas/BuiltCampaignControllerTriggerEventTargetingResponse' EXPRESSION: '#/components/schemas/BuiltCampaignControllerTriggerExpressionResponse' GROUP: '#/components/schemas/BuiltCampaignControllerTriggerGroupResponse' HAS_IDENTITY: '#/components/schemas/BuiltCampaignControllerTriggerHasIdentityResponse' HAS_PRIOR_REWARD: '#/components/schemas/BuiltCampaignControllerTriggerHasPriorRewardResponse' HAS_PRIOR_STEP: '#/components/schemas/BuiltCampaignControllerTriggerHasPriorStepResponse' JOURNEY_CHECK: '#/components/schemas/BuiltCampaignControllerTriggerJourneyCheckResponse' LEGACY_LABEL_TARGETING: '#/components/schemas/BuiltCampaignControllerTriggerLegacyLabelTargetingResponse' LEGACY_QUALITY: '#/components/schemas/BuiltCampaignControllerTriggerLegacyQualityResponse' MAXMIND: '#/components/schemas/BuiltCampaignControllerTriggerMaxMindResponse' REFERRED_BY_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerReferredByEventResponse' REWARD_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerRewardEventResponse' SCORE: '#/components/schemas/BuiltCampaignControllerTriggerScoreResponse' SEND_REWARD_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerSendRewardEventResponse' SHARE: '#/components/schemas/BuiltCampaignControllerTriggerShareResponse' STEP_EVENT: '#/components/schemas/BuiltCampaignControllerTriggerStepEventResponse' STICKY_JOURNEY: '#/components/schemas/BuiltCampaignControllerTriggerStickyJourneyResponse' TARGETING: '#/components/schemas/BuiltCampaignControllerTriggerTargetingResponse' ZONE_STATE: '#/components/schemas/BuiltCampaignControllerTriggerZoneStateResponse' propertyName: trigger_type oneOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerAccessResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerClientDomainResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerDataIntelligenceEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerEventTargetingResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerExpressionResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerGroupResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerHasIdentityResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerHasPriorRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerHasPriorStepResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerJourneyCheckResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerLegacyLabelTargetingResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerLegacyQualityResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerMaxMindResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerReferredByEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerRewardEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerScoreResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerSendRewardEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerShareResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerStepEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerStickyJourneyResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerTargetingResponse' - $ref: '#/components/schemas/BuiltCampaignControllerTriggerZoneStateResponse' required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type CampaignControllerActionRedeemRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REDEEM_REWARD type: string data: additionalProperties: type: string type: object event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionRedeemRewardResponse' partner_event_id: type: string reward_id: type: string type: object type: object PartnerUserIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PARTNER_USER_ID type: string type: object CampaignFlowStepMetricResponse: description: Stored campaign flow step metric definition. Fields `name`, `description`, `expression`, `unit`, and `tags` are unevaluated and appear in buildtime-evaluatable form. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepMetricResponse' expression: $ref: '#/components/schemas/ExpressionInCampaignFlowStepMetricResponse' id: readOnly: true type: string name: $ref: '#/components/schemas/NameInCampaignFlowStepMetricResponse' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepMetricResponse' unit: $ref: '#/components/schemas/UnitInCampaignFlowStepMetricResponse' required: - component_ids - component_references - description - expression - id - name - tags - unit type: object TriggerNameInCampaignControllerTriggerResponseBase: description: 'The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal trigger name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{triggerName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('triggerName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionSignalV1Response: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL_V1 type: string data: additionalProperties: type: string type: object signal_polling_id: type: string type: object type: object VerbNameInCampaignFlowStepWordsResponse: description: 'The verb name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal verb name title: Static Value - description: Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: handlebars@buildtime:{{verbName}} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('verbName');} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsAudienceIdList: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - AUDIENCE_ID_LIST type: string 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 type: object CampaignControllerTriggerZoneStateResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: invert_mapping_state: type: boolean step_name: $ref: '#/components/schemas/StepNameInCampaignControllerTriggerZoneStateResponse' trigger_type: enum: - ZONE_STATE type: string zone_name: $ref: '#/components/schemas/ZoneNameInCampaignControllerTriggerZoneStateResponse' type: object type: object BuiltCampaignControllerActionShareEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SHARE_EVENT type: string required: - action_id - action_type - component_ids - component_references - enabled - quality type: object PersistTypesInStepDataResponse: description: 'The persist types as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal persist types items: enum: - JOURNEY - PROFILE - STEP type: string title: Static Value type: array - 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:{{persistTypes}} 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('persistTypes');} 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 FlowPathInCampaignFlowStepResponse: description: 'The flow path as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal flow path title: Static Value - 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:{{flowPath}} 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('flowPath');} 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 PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner event id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{partnerEventId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('partnerEventId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionScheduleResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionScheduleResponse' type: object PartnerEventId: properties: name: type: string value: type: string type: object ResponseInBuiltCampaignControllerActionDisplayResponse: description: 'The response as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Literal response title: Static Value - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignDuplicateRequest: properties: description: nullable: true type: string message: nullable: true type: string name: nullable: true type: string program_label: nullable: true type: string required: - description - message - name - program_label type: object CampaignComponentVariableResponseAsExtoleClientKey: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - EXTOLE_CLIENT_KEY type: string 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 type: object FilterExpressionInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter expression title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterExpression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterExpression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts). example: handlebars@runtime:{{filterExpression}} externalDocs: description: RewardHasPriorRewardTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterExpression');} externalDocs: description: RewardHasPriorRewardTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentVariableResponseAsBoolean: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - BOOLEAN type: string 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 type: object CampaignLaunchTestRequest: properties: message: nullable: true type: string start_date: $ref: '#/components/schemas/ZonedDateTime' stop_date: $ref: '#/components/schemas/ZonedDateTime' type: object EventNamesInCampaignControllerTriggerStepEventResponse: description: 'The event names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsBrowserSideJavascript: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - BROWSER_SIDE_JAVASCRIPT type: string type: object type: object WebhookIdInCampaignComponentPartnerEnumListVariableResponse: description: 'The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal webhook id 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:{{webhookId}} 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('webhookId');} 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 CampaignScheduleStateRequest: properties: date: $ref: '#/components/schemas/ZonedDateTime' type: object FilterFaceValueTypesInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter face value types as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter face value types items: enum: - AUD - BRL - CAD - CNY - EUR - GBP - HKD - INR - JPY - KRW - MONTH - MXN - NZD - PERCENT_OFF - POINTS - TRY - TWD - USD type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterFaceValueTypes}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterFaceValueTypes');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInBuiltCampaignControllerActionWebhookResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionWebhookResponse' type: object EventNamesInCampaignControllerTriggerEventResponse: description: 'The event names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event names items: type: string title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string SumOfValueMinInCampaignControllerTriggerHasPriorStepResponse: description: 'The sum of value min as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal sum of value min title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{sumOfValueMin}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('sumOfValueMin');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionFulfillRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - FULFILL_REWARD type: string event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFulfillRewardResponse' message: type: string partner_reward_id: $ref: '#/components/schemas/PartnerRewardIdInCampaignControllerActionFulfillRewardResponse' reward_id: type: string success: type: string type: object type: object FilterExpressionInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter expression title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterExpression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterExpression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterExpression}} externalDocs: description: StepHasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterExpression');} externalDocs: description: StepHasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: StepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: StepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerTriggerReferredByEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: referral_originator: enum: - ADVOCATE - FRIEND nullable: true type: string trigger_type: enum: - REFERRED_BY_EVENT type: string type: object type: object BuiltCampaignFlowStepWordsResponse: properties: person_counting_name: type: string plural_noun_name: type: string rate_name: type: string singular_noun_name: type: string verb_name: type: string type: object EnabledInCampaignStepResponseBase: description: 'The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled title: Static Value type: boolean - 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:{{enabled}} 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('enabled');} 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 FilterMaxAgeInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter max age as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Duration' description: Literal filter max age title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMaxAge}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMaxAge');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentClientKeyFlowVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: authorization_url: type: string client_secret_key_id: type: string redirect_url: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - CLIENT_KEY_FLOW type: string 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 client key flow variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - authorization_url - client_secret_key_id - description - display_name - name - priority - redirect_url - source - tags - type - values type: object ExtraDataInBuiltCampaignControllerActionScheduleResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTimeInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal event time title: Static Value - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TaxYearStartInCampaignControllerTriggerHasPriorRewardResponse: description: 'The tax year start as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/MonthDay' description: Literal tax year start title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{taxYearStart}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('taxYearStart');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsDelay: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - DELAY type: string 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 type: object LabelInCampaignControllerTriggerStickyJourneyResponse: description: 'The label as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal label title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{label}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('label');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionCancelRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CANCEL_REWARD type: string message: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - quality - reward_id type: object CampaignStepResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' data: items: $ref: '#/components/schemas/StepDataResponse' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignStepResponseBase' id: readOnly: true type: string step_builder: $ref: '#/components/schemas/StepBuilderInCampaignStepResponseBase' triggers: items: $ref: '#/components/schemas/CampaignControllerTriggerResponse' type: array type: enum: - CONTROLLER - FRONTEND_CONTROLLER - JOURNEY_ENTRY type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object CampaignControllerTriggerHasPriorStepResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: count_matches: $ref: '#/components/schemas/CountMatchesInCampaignControllerTriggerHasPriorStepResponse' count_max: $ref: '#/components/schemas/CountMaxInCampaignControllerTriggerHasPriorStepResponse' count_min: $ref: '#/components/schemas/CountMinInCampaignControllerTriggerHasPriorStepResponse' filter_campaign_id: type: string filter_campaign_ids: $ref: '#/components/schemas/FilterCampaignIdsInCampaignControllerTriggerHasPriorStepResponse' filter_expression: $ref: '#/components/schemas/FilterExpressionInCampaignControllerTriggerHasPriorStepResponse' filter_expressions: items: type: string type: array uniqueItems: true filter_max_age: $ref: '#/components/schemas/FilterMaxAgeInCampaignControllerTriggerHasPriorStepResponse' filter_max_date: $ref: '#/components/schemas/FilterMaxDateInCampaignControllerTriggerHasPriorStepResponse' filter_max_value: $ref: '#/components/schemas/FilterMaxValueInCampaignControllerTriggerHasPriorStepResponse' filter_min_age: $ref: '#/components/schemas/FilterMinAgeInCampaignControllerTriggerHasPriorStepResponse' filter_min_date: $ref: '#/components/schemas/FilterMinDateInCampaignControllerTriggerHasPriorStepResponse' filter_min_value: $ref: '#/components/schemas/FilterMinValueInCampaignControllerTriggerHasPriorStepResponse' filter_names: $ref: '#/components/schemas/FilterNamesInCampaignControllerTriggerHasPriorStepResponse' filter_partner_event_id: $ref: '#/components/schemas/FilterPartnerEventIdInCampaignControllerTriggerHasPriorStepResponse' filter_partner_event_id_name: type: string filter_partner_event_id_value: type: string filter_program_label: type: string filter_program_labels: $ref: '#/components/schemas/FilterProgramLabelsInCampaignControllerTriggerHasPriorStepResponse' filter_quality: $ref: '#/components/schemas/FilterQualityInCampaignControllerTriggerHasPriorStepResponse' filter_scope: $ref: '#/components/schemas/FilterScopeInCampaignControllerTriggerHasPriorStepResponse' having_all_names: $ref: '#/components/schemas/HavingAllNamesInCampaignControllerTriggerHasPriorStepResponse' person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerTriggerHasPriorStepResponse' sum_of_value_max: $ref: '#/components/schemas/SumOfValueMaxInCampaignControllerTriggerHasPriorStepResponse' sum_of_value_min: $ref: '#/components/schemas/SumOfValueMinInCampaignControllerTriggerHasPriorStepResponse' trigger_type: enum: - HAS_PRIOR_STEP type: string type: object type: object BuiltCampaignControllerTriggerHasIdentityResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - HAS_IDENTITY type: string required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object BuiltComponentSocketResponseAsSocket: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponse' type: array type: enum: - SOCKET type: string type: object required: - description - display_name - filters - name - parameters - priority - tags - type - values type: object DataInCampaignControllerActionIncentivizeResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentVariableResponseAsCss: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - CSS type: string 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 type: object CampaignControllerActionWebhookResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - WEBHOOK type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionWebhookResponse' webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignControllerActionWebhookResponse' type: object type: object BuiltCampaignControllerActionEarnRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EARN_REWARD type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionEarnRewardResponse' extra_data: $ref: '#/components/schemas/ExtraDataInBuiltCampaignControllerActionEarnRewardResponse' reward_action_id: $ref: '#/components/schemas/RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse' reward_name: type: string reward_supplier_id: type: string slots: $ref: '#/components/schemas/SlotsInBuiltCampaignControllerActionEarnRewardResponse' tags: $ref: '#/components/schemas/TagsInBuiltCampaignControllerActionEarnRewardResponse' value_of_event_being_rewarded: $ref: '#/components/schemas/ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse' type: object required: - action_id - action_type - component_ids - component_references - data - enabled - extra_data - quality - reward_action_id - reward_name - reward_supplier_id - slots - tags - value_of_event_being_rewarded type: object DatesInBuiltCampaignControllerActionScheduleResponse: description: 'The dates as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltComponentSocketResponseAsMultiSocket: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponse' type: array type: enum: - MULTI_SOCKET type: string type: object required: - description - display_name - filters - name - parameters - priority - tags - type - values type: object PluralNounNameInCampaignFlowStepWordsResponse: description: 'The plural noun name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal plural noun name title: Static Value - description: Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: handlebars@buildtime:{{pluralNounName}} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('pluralNounName');} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionResponseBase: properties: action_id: type: string action_type: enum: - APPROVE - CANCEL_REWARD - CREATE_MEMBERSHIP - CREATIVE - DATA_INTELLIGENCE - DECLINE - DISPLAY - EARN_REWARD - EMAIL - EXPRESSION - FIRE_AS_PERSON - FULFILL_REWARD - INCENTIVIZE - INCENTIVIZE_STATUS_UPDATE - REDEEM_REWARD - REMOVE_MEMBERSHIP - REVOKE_REWARD - SCHEDULE - SHARE_EVENT - SIGNAL - SIGNAL_V1 - STEP_SIGNAL - WEBHOOK type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionResponseBase' quality: enum: - ALWAYS - HIGH - LOW type: string type: object BuiltComponentEnumVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ENUM type: string type: object required: - allowed_values - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object CampaignComponentEnumListVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - ENUM_LIST type: string 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 enum list variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - allowed_values - description - display_name - name - priority - source - tags - type - values type: object FilterNamesInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string KeyTypeInStepDataResponse: description: 'The key type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal key type enum: - NONE - PARTNER_EVENT_KEY - PARTNER_PROFILE_KEY - UNIQUE_PARTNER_EVENT_KEY - VALUE 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:{{keyType}} 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('keyType');} 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 EventTypeInCampaignControllerTriggerEventResponse: description: 'The event type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event type enum: - ASSET - DATA_INTELLIGENCE - DISPLACED - DISPLACED_BY - FORWARDED - IDENTIFIED - INPUT - INTERNAL - LEGACY_CONSUMER_EVENT - MESSAGE - MESSAGE_NOT_DELIVERED - REFERRED - REFERRED_BY - SCHEDULED - SHARE - SHAREABLE - STEP title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string HavingAnyAudienceIdInCampaignControllerTriggerAudienceMembershipResponse: description: 'The having any audience id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal having any audience id items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{havingAnyAudienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('havingAnyAudienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ParentTriggerGroupNameInCampaignControllerTriggerResponseBase: description: 'The parent trigger group name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal parent trigger group name title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{parentTriggerGroupName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('parentTriggerGroupName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsInteger: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - INTEGER type: string 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 type: object DataMapInBuiltCampaignControllerActionEarnRewardResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionEarnRewardResponse' type: object ComponentAssetResponse: properties: description: type: string filename: type: string id: type: string name: type: string tags: items: type: string type: array uniqueItems: true type: object BuiltCampaignControllerActionIncentivizeResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_name: type: string action_type: enum: - INCENTIVIZE type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeResponse' incentivize_action_type: enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string overrides: additionalProperties: type: string type: object review_status: enum: - EVALUATING - PENDING type: string type: object type: object DefaultValueInBuiltStepDataResponse: description: 'The default value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal default value title: Static Value type: object - description: Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{defaultValue}} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('defaultValue');} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExpressionInCampaignFlowStepMetricResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal expression title: Static Value - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FilterMinAgeInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter min age as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Duration' description: Literal filter min age title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMinAge}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMinAge');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerHasPriorStepResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: count_matches: items: format: int32 type: integer type: array uniqueItems: true count_max: format: int32 type: integer count_min: format: int32 type: integer filter_campaign_id: type: string filter_campaign_ids: $ref: '#/components/schemas/FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse' filter_expression: $ref: '#/components/schemas/FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse' filter_expressions: items: type: string type: array uniqueItems: true filter_max_age: $ref: '#/components/schemas/Duration' filter_max_date: $ref: '#/components/schemas/ZonedDateTime' filter_max_value: type: number filter_min_age: $ref: '#/components/schemas/Duration' filter_min_date: $ref: '#/components/schemas/ZonedDateTime' filter_min_value: type: number filter_names: items: type: string type: array uniqueItems: true filter_partner_event_id: $ref: '#/components/schemas/PartnerEventId' filter_partner_event_id_name: type: string filter_partner_event_id_value: type: string filter_program_label: type: string filter_program_labels: $ref: '#/components/schemas/FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse' filter_quality: enum: - ANY - HIGH - LOW type: string filter_scope: enum: - ATTRIBUTED - CAMPAIGN - CLIENT - JOURNEY - PROGRAM type: string having_all_names: $ref: '#/components/schemas/HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse' person_id: $ref: '#/components/schemas/PersonIdInBuiltCampaignControllerTriggerHasPriorStepResponse' sum_of_value_max: type: number sum_of_value_min: type: number trigger_type: enum: - HAS_PRIOR_STEP type: string type: object required: - component_ids - component_references - count_matches - count_max - count_min - enabled - filter_campaign_id - filter_campaign_ids - filter_expression - filter_expressions - filter_max_age - filter_max_date - filter_max_value - filter_min_age - filter_min_date - filter_min_value - filter_names - filter_partner_event_id - filter_partner_event_id_name - filter_partner_event_id_value - filter_program_label - filter_program_labels - filter_quality - filter_scope - having_all_names - negated - parent_trigger_group_name - person_id - sum_of_value_max - sum_of_value_min - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object FilterMaxDateInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter max date as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal filter max date title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMaxDate}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMaxDate');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltComponentComponentSettingLookupVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: capture_settings: items: type: string type: array captured_setting_values_description: type: string description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array matching_filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COMPONENT_SETTING_LOOKUP type: string type: object required: - capture_settings - captured_setting_values_description - description - display_name - filters - matching_filters - name - priority - source - source_component_id - source_version - tags - type - values type: object CampaignControllerTriggerJourneyCheckResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: journey_name: $ref: '#/components/schemas/JourneyNameInCampaignControllerTriggerJourneyCheckResponse' person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerTriggerJourneyCheckResponse' trigger_type: enum: - JOURNEY_CHECK type: string type: object type: object StepNameInCampaignControllerTriggerZoneStateResponse: description: 'The step name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal step name title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{stepName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('stepName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ValueInStepDataResponse: description: 'The value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value title: Static Value type: object - 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:{{value}} 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('value');} 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 - description: Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignComponentVariableResponseAsClientKey: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_KEY type: string type: object type: object CampaignComponentVariableResponseAsImage: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - IMAGE type: string 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 type: object EventNameInCampaignControllerTriggerDataIntelligenceEventResponse: description: 'The event name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInBuiltCampaignControllerActionExpressionResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionSignalResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerJourneyCheckResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: journey_name: type: string person_id: $ref: '#/components/schemas/PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse' trigger_type: enum: - JOURNEY_CHECK type: string type: object type: object ValueInJourneyKeyResponse: description: 'The value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value title: Static Value type: object - 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:{{value}} 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('value');} 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 - description: Handlebars expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: JourneyKeyContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: JourneyKeyContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PriorityInCampaignJourneyEntryResponse: description: 'The priority as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal priority properties: size: format: int32 type: integer title: Static Value type: object - 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:{{priority}} 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('priority');} 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 SettingFilterResponseBase: properties: type: enum: - COMPONENT_TYPE - EXPRESSION - FACET type: string type: object TriggerPhaseInCampaignControllerTriggerResponseBase: description: 'The trigger phase as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal trigger phase enum: - MATCHING - QUALIFYING - QUALITY title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{triggerPhase}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('triggerPhase');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal legacy action id title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerRewardIdInCampaignControllerActionFulfillRewardResponse: description: 'The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner reward id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionScheduleResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionScheduleResponse' type: object CampaignControllerActionStepSignalResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - STEP_SIGNAL type: string name: type: string polling_id: type: string type: object type: object AliasesInCampaignFrontendControllerResponse: description: 'The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal aliases items: type: string title: Static Value type: array uniqueItems: true - 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:{{aliases}} 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('aliases');} 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 DataMapInCampaignControllerActionWebhookResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionWebhookResponse' type: object CampaignControllerActionIncentivizeStatusUpdateResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - INCENTIVIZE_STATUS_UPDATE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse' event_type: $ref: '#/components/schemas/EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse' message: $ref: '#/components/schemas/MessageInCampaignControllerActionIncentivizeStatusUpdateResponse' move_to_pending: $ref: '#/components/schemas/MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse' partner_event_id: $ref: '#/components/schemas/PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse' review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse' type: object type: object EventNameInCampaignControllerActionFireAsPersonResponse: description: 'The event name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string JourneyKeyResponse: properties: name: $ref: '#/components/schemas/NameInJourneyKeyResponse' value: $ref: '#/components/schemas/ValueInJourneyKeyResponse' type: object BuiltCampaignControllerTriggerAudienceMembershipEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: audience_ids: items: type: string type: array uniqueItems: true event_types: items: enum: - CREATED - REMOVED - UPDATED type: string type: array uniqueItems: true trigger_type: enum: - AUDIENCE_MEMBERSHIP_EVENT type: string type: object required: - audience_ids - component_ids - component_references - enabled - event_types - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object DataInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionWebhookResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionFireAsPersonResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string VariantsInCampaignResponse: description: 'The variants as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal variants items: type: string title: Static Value type: array - 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:{{variants}} 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('variants');} 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 ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse: description: 'The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value of event being rewarded title: Static Value type: object - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ZoneNameInCampaignControllerTriggerZoneStateResponse: description: 'The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal zone name title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{zoneName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('zoneName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DimensionInStepDataResponse: description: 'The dimension as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal dimension title: Static Value type: boolean - 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:{{dimension}} 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('dimension');} 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 CampaignControllerTriggerSendRewardEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: reward_names: $ref: '#/components/schemas/RewardNamesInCampaignControllerTriggerSendRewardEventResponse' reward_states: $ref: '#/components/schemas/RewardStatesInCampaignControllerTriggerSendRewardEventResponse' tags: $ref: '#/components/schemas/TagsInCampaignControllerTriggerSendRewardEventResponse' trigger_type: enum: - SEND_REWARD_EVENT type: string type: object type: object DataMapInCampaignControllerActionEmailResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEmailResponse' type: object CampaignControllerActionShareEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SHARE_EVENT type: string type: object type: object ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse: description: 'The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value of event being rewarded title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{valueOfEventBeingRewarded}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('valueOfEventBeingRewarded');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignComponentRewardSupplierIdListVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: allowed_reward_supplier_ids: $ref: '#/components/schemas/AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableResponse' source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - REWARD_SUPPLIER_ID_LIST type: string 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 reward supplier id list variable definition. Fields `description` and `allowed_reward_supplier_ids` are unevaluated and appear in buildtime-evaluatable form. required: - allowed_reward_supplier_ids - description - display_name - name - priority - source - tags - type - values type: object BuiltComponentAssetResponse: properties: description: type: string filename: type: string id: readOnly: true type: string name: type: string tags: items: type: string type: array uniqueItems: true required: - description - filename - id - name - tags type: object CampaignComponentSocketResponseAsSocket: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/CampaignComponentVariableResponse' type: array socketed_component_ids: items: type: string type: array type: enum: - SOCKET type: string type: object description: Stored campaign component socket definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - description - display_name - filters - name - parameters - priority - socketed_component_ids - tags - type type: object DescriptionInCampaignComponentSettingResponseBase: description: 'The description as configured: a literal value, or an expression (type:string) when defined dynamically.' 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 BuiltCampaignControllerActionStepSignalResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - STEP_SIGNAL type: string name: type: string polling_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - name - polling_id - quality type: object CampaignControllerTriggerGroupResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: operator: $ref: '#/components/schemas/OperatorInCampaignControllerTriggerGroupResponse' trigger_type: enum: - GROUP type: string type: object type: object CampaignFrontendControllerResponse: allOf: - $ref: '#/components/schemas/CampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/CampaignControllerActionResponse' type: array aliases: $ref: '#/components/schemas/AliasesInCampaignFrontendControllerResponse' category: $ref: '#/components/schemas/CategoryInCampaignFrontendControllerResponse' enabled_on_states: $ref: '#/components/schemas/EnabledOnStatesInCampaignFrontendControllerResponse' id: readOnly: true type: string journey_names: $ref: '#/components/schemas/JourneyNamesInCampaignFrontendControllerResponse' name: $ref: '#/components/schemas/NameInCampaignFrontendControllerResponse' scope: $ref: '#/components/schemas/ScopeInCampaignFrontendControllerResponse' send_policy: $ref: '#/components/schemas/SendPolicyInCampaignFrontendControllerResponse' type: enum: - FRONTEND_CONTROLLER type: string type: object description: Stored campaign frontend controller definition. Fields `enabled`, `name`, `scope`, `enabled_on_states`, `category`, `aliases`, `journey_names`, `send_policy`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. required: - actions - aliases - category - component_ids - component_references - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - send_policy - step_builder - triggers - type - updated_date type: object CampaignStepResponse: discriminator: mapping: CONTROLLER: '#/components/schemas/CampaignControllerResponse' FRONTEND_CONTROLLER: '#/components/schemas/CampaignFrontendControllerResponse' JOURNEY_ENTRY: '#/components/schemas/CampaignJourneyEntryResponse' propertyName: type oneOf: - $ref: '#/components/schemas/CampaignControllerResponse' - $ref: '#/components/schemas/CampaignFrontendControllerResponse' - $ref: '#/components/schemas/CampaignJourneyEntryResponse' required: - component_ids - component_references - created_date - data - enabled - id - step_builder - triggers - type - updated_date CampaignControllerTriggerAccessResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - ACCESS type: string trusted_scopes: items: enum: - BACKEND - CLIENT_ADMIN - CLIENT_REPORT_DOWNLOAD - CLIENT_SUPERUSER - ONE_TIME - PASSWORD_RESET - UPDATE_PROFILE - USER_SUPPORT - VERIFIED_CONSUMER type: string type: array uniqueItems: true type: object type: object 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 CampaignFlowStepAppResponse: description: Stored campaign flow step app definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepAppResponse' id: readOnly: true type: string name: $ref: '#/components/schemas/NameInCampaignFlowStepAppResponse' type: $ref: '#/components/schemas/CampaignFlowStepAppTypeResponse' required: - component_ids - component_references - description - id - name - type type: object FilterCampaignIdsInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter campaign ids items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterCampaignIds}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterCampaignIds');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterCampaignIds}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('filterCampaignIds');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string HavingAllNamesInCampaignControllerTriggerHasPriorStepResponse: description: 'The having all names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal having all names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{havingAllNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('havingAllNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{havingAllNames}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('havingAllNames');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerTriggerShareResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: channels: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true quality: enum: - ANY - HIGH - LOW type: string share_types: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true writeOnly: true trigger_type: enum: - SHARE type: string type: object type: object FilterQualityInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter quality as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter quality enum: - ANY - HIGH - LOW title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterQuality}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterQuality');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerScoreResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: cause_event_name: type: string channel: type: string score_result: type: string trigger_type: enum: - SCORE type: string type: object required: - cause_event_name - channel - component_ids - component_references - enabled - negated - parent_trigger_group_name - score_result - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object BuiltCampaignControllerTriggerShareResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: channels: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true quality: enum: - ANY - HIGH - LOW type: string share_types: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true writeOnly: true trigger_type: enum: - SHARE type: string type: object required: - channels - component_ids - component_references - enabled - negated - parent_trigger_group_name - quality - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object BuiltCampaignResponse: description: campaign after buildtime evaluation. Fields `variant_selector` and `variants` are already evaluated. properties: campaign_id: type: string campaign_locks: items: enum: - DUPLICATE - EDIT type: string type: array uniqueItems: true campaign_type: enum: - CONFIGURATION - EXTENSION - INTEGRATION - MARKETING type: string components: items: $ref: '#/components/schemas/BuiltCampaignComponentResponse' type: array description: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' flow_steps: items: $ref: '#/components/schemas/BuiltCampaignFlowStepResponse' type: array incentive: $ref: '#/components/schemas/IncentiveResponse' incentive_id: type: string is_published: type: boolean labels: items: $ref: '#/components/schemas/CampaignLabelResponse' type: array last_published_date: $ref: '#/components/schemas/ZonedDateTime' name: type: string parent_version: format: int32 type: integer pause_date: $ref: '#/components/schemas/ZonedDateTime' program_label: type: string program_type: type: string start_date: $ref: '#/components/schemas/ZonedDateTime' state: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string steps: items: $ref: '#/components/schemas/BuiltCampaignStepResponse' type: array stop_date: $ref: '#/components/schemas/ZonedDateTime' tags: items: type: string type: array uniqueItems: true theme_name: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' variant_selector: $ref: '#/components/schemas/VariantSelectorInBuiltCampaignResponse' variants: items: type: string type: array version: format: int32 type: integer required: - campaign_id - campaign_locks - campaign_type - components - description - end_date - flow_steps - incentive - incentive_id - is_published - labels - last_published_date - name - parent_version - pause_date - program_label - program_type - start_date - state - steps - stop_date - tags - theme_name - updated_date - variant_selector - variants - version type: object BuiltCampaignControllerTriggerEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array event_type: enum: - ASSET - DATA_INTELLIGENCE - DISPLACED - DISPLACED_BY - FORWARDED - IDENTIFIED - INPUT - INTERNAL - LEGACY_CONSUMER_EVENT - MESSAGE - MESSAGE_NOT_DELIVERED - REFERRED - REFERRED_BY - SCHEDULED - SHARE - SHAREABLE - STEP type: string trigger_type: enum: - EVENT type: string type: object type: object RiskThresholdInCampaignControllerTriggerMaxMindResponse: description: 'The risk threshold as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal risk threshold format: int64 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{riskThreshold}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('riskThreshold');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltJourneyKeyResponse: properties: name: type: string value: $ref: '#/components/schemas/ValueInBuiltJourneyKeyResponse' type: object SignalPollingIdInBuiltCampaignControllerActionSignalResponse: description: 'The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal signal polling id title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerDataIntelligenceEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_name: type: string trigger_type: enum: - DATA_INTELLIGENCE_EVENT type: string type: object required: - component_ids - component_references - enabled - event_name - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type 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 type: object SelectorsInCampaignControllerResponse: description: 'The selectors as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal selectors items: enum: - BEST_REFERRAL - BEST_REFERRAL_SAME_PROGRAM - MATCHING_CAMPAIGN - TARGET type: string title: Static Value type: array - 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:{{selectors}} 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('selectors');} 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 QualityRuleResponse: properties: action_types: items: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string type: array uniqueItems: true enabled: type: boolean id: readOnly: true type: string properties: additionalProperties: items: type: string type: array type: object rule_type: enum: - BAD_COUNTRY - BLACKLIST_DOMAIN - BLACKLIST_REFERER_HEADER - BLOCKED - BOT_FILTER - EVENT_SPEED - EXISTING_CUSTOMER - FRIENDS_OF_ADVOCATE_CLICK_LIMIT - FRIENDS_OF_ADVOCATE_CONVERSION_LIMIT - FRIENDS_OF_ADVOCATE_REGISTRATION_LIMIT - GENERIC - GLOBAL_BLOCK - IP_FILTER - PERSON_DATA - PREVIEW - PROFILE_DISPLACED - RECENT_CUSTOMER - RECIPIENT_LIMIT - REFERRAL_AGE - REFERRAL_CAP - SAME_IP - SELF_REFERRAL - SHARE_COUNT_LIMIT - SIMILAR_FRIEND_ADVOCATE_EMAIL - SPAM_MESSAGE - VALID_EMAIL type: string required: - action_types - enabled - id - properties - rule_type type: object RewardRuleResponse: properties: count_rewards_based_on_partner_user_id: nullable: true type: boolean data_attribute_matcher_type: enum: - EXACT - REGEX nullable: true type: string data_attribute_name: nullable: true type: string data_attribute_value: nullable: true type: string expression: $ref: '#/components/schemas/RewardRuleExpression' id: readOnly: true type: string is_email_required: type: boolean is_referral_loop_allowed: type: boolean is_unique_friend_required: type: boolean min_cart_value: type: number referrals_per_reward: format: int32 type: integer reward_count_limit: format: int32 type: integer reward_count_since_days: format: int32 nullable: true type: integer reward_count_since_month: format: int32 nullable: true type: integer reward_every_x_friend_actions: format: int32 nullable: true type: integer reward_slots: items: type: string type: array uniqueItems: true reward_supplier_id: type: string reward_value_limit: type: number reward_value_since_days: format: int32 nullable: true type: integer reward_value_since_month: format: int32 nullable: true type: integer rewardee: enum: - ADVOCATE - FRIEND type: string trigger_action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string required: - count_rewards_based_on_partner_user_id - data_attribute_matcher_type - data_attribute_name - data_attribute_value - expression - id - is_email_required - is_referral_loop_allowed - is_unique_friend_required - min_cart_value - referrals_per_reward - reward_count_limit - reward_count_since_days - reward_count_since_month - reward_every_x_friend_actions - reward_slots - reward_supplier_id - reward_value_limit - reward_value_since_days - reward_value_since_month - rewardee - trigger_action_type type: object BodyInBuiltCampaignControllerActionDisplayResponse: description: 'The body as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal body title: Static Value - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EmailFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - EMAIL type: string type: object DataInCampaignControllerActionExpressionResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionIncentivizeResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionIncentivizeResponse' type: object BuiltCampaignComponentSettingResponseBase: properties: 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_SETTING_LOOKUP - CSS - 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 - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string values: $ref: '#/components/schemas/BuiltComponentSettingValues' type: object BuiltCampaignJourneyEntryResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: id: readOnly: true type: string journey_name: type: string key: $ref: '#/components/schemas/BuiltJourneyKeyResponse' priority: $ref: '#/components/schemas/DeweyDecimal' type: enum: - JOURNEY_ENTRY type: string type: object required: - component_ids - component_references - created_date - data - enabled - id - journey_name - key - priority - step_builder - triggers - type - updated_date type: object EventTimeInCampaignControllerActionRedeemRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignJourneyEntryResponse: allOf: - $ref: '#/components/schemas/CampaignStepResponseBase' - properties: id: readOnly: true type: string journey_name: $ref: '#/components/schemas/JourneyNameInCampaignJourneyEntryResponse' key: $ref: '#/components/schemas/JourneyKeyResponse' priority: $ref: '#/components/schemas/PriorityInCampaignJourneyEntryResponse' type: enum: - JOURNEY_ENTRY type: string type: object description: Stored campaign journey entry definition. Fields `enabled`, `journey_name`, `priority`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. required: - component_ids - component_references - created_date - data - enabled - id - journey_name - key - priority - step_builder - triggers - type - updated_date type: object CampaignComponentSocketResponseAsMultiSocket: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/CampaignComponentVariableResponse' type: array socketed_component_ids: items: type: string type: array type: enum: - MULTI_SOCKET type: string type: object description: Stored campaign component socket definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. required: - description - display_name - filters - name - parameters - priority - socketed_component_ids - tags - type type: object CountMatchesInCampaignControllerTriggerHasPriorRewardResponse: description: 'The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count matches items: format: int32 type: integer title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMatches}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMatches');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionScheduleResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SCHEDULE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionScheduleResponse' dates: $ref: '#/components/schemas/DatesInCampaignControllerActionScheduleResponse' delays: $ref: '#/components/schemas/DelaysInCampaignControllerActionScheduleResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionScheduleResponse' force: type: boolean schedule_name: $ref: '#/components/schemas/ScheduleNameInCampaignControllerActionScheduleResponse' type: object type: object RewardRuleExpression: properties: type: enum: - JS - SPEL type: string value: type: string type: object ClientDomainIdsInCampaignControllerTriggerClientDomainResponse: description: 'The client domain ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal client domain ids items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{clientDomainIds}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('clientDomainIds');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignFlowStepAppTypeResponse: properties: name: $ref: '#/components/schemas/NameInCampaignFlowStepAppTypeResponse' type: object RewardTagsInCampaignControllerActionApproveResponse: description: 'The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardTags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardTags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInCampaignFlowStepMetricResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentOriginResponse: properties: client_id: type: string component_id: type: string component_version: format: int32 type: integer type: object IconTypeInCampaignFlowStepResponse: description: 'The icon type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal icon type title: Static Value - 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:{{iconType}} 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('iconType');} 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 AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableResponse: description: 'The allowed reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal allowed reward supplier ids items: type: string title: Static Value type: array - 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:{{allowedRewardSupplierIds}} 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('allowedRewardSupplierIds');} 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 DataInBuiltCampaignControllerActionScheduleResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TransitionRuleResponse: properties: action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string approve_high_quality: type: boolean approve_low_quality: type: boolean transition_period_milliseconds: format: int64 type: integer transition_rule_id: type: string required: - action_type - approve_high_quality - approve_low_quality - transition_period_milliseconds - transition_rule_id type: object SumOfFaceValueMinInCampaignControllerTriggerHasPriorRewardResponse: description: 'The sum of face value min as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal sum of face value min title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{sumOfFaceValueMin}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('sumOfFaceValueMin');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string IpThresholdInCampaignControllerTriggerMaxMindResponse: description: 'The ip threshold as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal ip threshold format: int64 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{ipThreshold}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('ipThreshold');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInCampaignFrontendControllerResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 BuiltComponentStringMapVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_keys: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING_MAP type: string type: object required: - allowed_keys - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object RewardStatesInCampaignControllerTriggerRewardEventResponse: description: 'The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward states items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardStates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardStates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdsInCampaignControllerTriggerAudienceMembershipEventResponse: description: 'The audience ids as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal audience ids items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceIds}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceIds');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsRewardSupplierId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - REWARD_SUPPLIER_ID type: string type: object type: object CampaignControllerTriggerScoreResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: cause_event_name: type: string channel: type: string score_result: type: string trigger_type: enum: - SCORE type: string type: object type: object LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal legacy action id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{legacyActionId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('legacyActionId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SuccessResponse: properties: status: type: string required: - status type: object BuiltComponentComponentIdVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filter: $ref: '#/components/schemas/ComponentIdFilterResponse' source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COMPONENT_ID type: string type: object required: - description - display_name - filter - name - priority - source - source_component_id - source_version - tags - type - values type: object ApiResponse: properties: body: type: string headers: additionalProperties: type: string type: object statusCode: format: int32 type: integer type: object DefaultInBuiltComponentSettingValues: 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 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 DataMapInBuiltCampaignControllerActionEmailResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionEmailResponse' type: object CampaignSummaryResponse: properties: campaign_id: type: string campaign_locks: items: enum: - DUPLICATE - EDIT type: string type: array campaign_type: enum: - CONFIGURATION - EXTENSION - INTEGRATION - MARKETING type: string description: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' is_published: type: boolean labels: items: $ref: '#/components/schemas/CampaignLabelResponse' type: array last_published_date: $ref: '#/components/schemas/ZonedDateTime' name: type: string pause_date: $ref: '#/components/schemas/ZonedDateTime' program_label: type: string program_type: type: string root_component_type: type: string start_date: $ref: '#/components/schemas/ZonedDateTime' state: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string stop_date: $ref: '#/components/schemas/ZonedDateTime' tags: items: type: string type: array uniqueItems: true theme_name: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' variants: items: type: string type: array required: - campaign_id - campaign_locks - campaign_type - description - end_date - is_published - labels - last_published_date - name - pause_date - program_label - program_type - root_component_type - start_date - state - stop_date - tags - theme_name - updated_date - variants 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 type: object SignalPollingIdInCampaignControllerActionSignalResponse: description: 'The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal signal polling id title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string Duration: description: '[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.' example: PT42S pattern: ^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$ type: string DataInBuiltCampaignControllerActionEarnRewardResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner event id title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignComponentVariableResponse: properties: description: type: string display_name: type: string name: type: string priority: $ref: '#/components/schemas/DeweyDecimal' source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer 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_SETTING_LOOKUP - CSS - 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 - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string values: $ref: '#/components/schemas/BuiltComponentSettingValues' type: object FilterTagsInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterTags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterTags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RateNameInCampaignFlowStepWordsResponse: description: 'The rate name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal rate name title: Static Value - description: Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: handlebars@buildtime:{{rateName}} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rateName');} externalDocs: description: FlowStepBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string IconColorInCampaignFlowStepResponse: description: 'The icon color as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal icon color title: Static Value - 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:{{iconColor}} 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('iconColor');} 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 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 CampaignControllerActionFireAsPersonResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - FIRE_AS_PERSON type: string as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' data: $ref: '#/components/schemas/DataMapInCampaignControllerActionFireAsPersonResponse' event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionFireAsPersonResponse' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFireAsPersonResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionFireAsPersonResponse' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerActionFireAsPersonResponse' type: object type: object BuiltComponentSettingValues: additionalProperties: true description: Open map of evaluated 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/DefaultInBuiltComponentSettingValues' en: $ref: '#/components/schemas/EnInBuiltComponentSettingValues' type: object BuiltCampaignControllerTriggerZoneStateResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: invert_mapping_state: type: boolean step_name: nullable: true type: string trigger_type: enum: - ZONE_STATE type: string zone_name: nullable: true type: string type: object required: - component_ids - component_references - enabled - invert_mapping_state - negated - parent_trigger_group_name - step_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type - zone_name type: object FilterNamesInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterNames}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterNames');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerStickyJourneyResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: label: type: string trigger_type: enum: - STICKY_JOURNEY type: string type: object type: object BuiltCampaignControllerActionResponse: discriminator: mapping: APPROVE: '#/components/schemas/BuiltCampaignControllerActionApproveResponse' CANCEL_REWARD: '#/components/schemas/BuiltCampaignControllerActionCancelRewardResponse' CREATE_MEMBERSHIP: '#/components/schemas/BuiltCampaignControllerActionCreateMembershipResponse' CREATIVE: '#/components/schemas/BuiltCampaignControllerActionCreativeResponse' DATA_INTELLIGENCE: '#/components/schemas/BuiltCampaignControllerActionDataIntelligenceResponse' DECLINE: '#/components/schemas/BuiltCampaignControllerActionDeclineResponse' DISPLAY: '#/components/schemas/BuiltCampaignControllerActionDisplayResponse' EARN_REWARD: '#/components/schemas/BuiltCampaignControllerActionEarnRewardResponse' EMAIL: '#/components/schemas/BuiltCampaignControllerActionEmailResponse' EXPRESSION: '#/components/schemas/BuiltCampaignControllerActionExpressionResponse' FIRE_AS_PERSON: '#/components/schemas/BuiltCampaignControllerActionFireAsPersonResponse' FULFILL_REWARD: '#/components/schemas/BuiltCampaignControllerActionFulfillRewardResponse' INCENTIVIZE: '#/components/schemas/BuiltCampaignControllerActionIncentivizeResponse' INCENTIVIZE_STATUS_UPDATE: '#/components/schemas/BuiltCampaignControllerActionIncentivizeStatusUpdateResponse' REDEEM_REWARD: '#/components/schemas/BuiltCampaignControllerActionRedeemRewardResponse' REMOVE_MEMBERSHIP: '#/components/schemas/BuiltCampaignControllerActionRemoveMembershipResponse' REVOKE_REWARD: '#/components/schemas/BuiltCampaignControllerActionRevokeRewardResponse' SCHEDULE: '#/components/schemas/BuiltCampaignControllerActionScheduleResponse' SHARE_EVENT: '#/components/schemas/BuiltCampaignControllerActionShareEventResponse' SIGNAL: '#/components/schemas/BuiltCampaignControllerActionSignalResponse' SIGNAL_V1: '#/components/schemas/BuiltCampaignControllerActionSignalV1Response' STEP_SIGNAL: '#/components/schemas/BuiltCampaignControllerActionStepSignalResponse' WEBHOOK: '#/components/schemas/BuiltCampaignControllerActionWebhookResponse' propertyName: action_type oneOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionApproveResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionCancelRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionCreateMembershipResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionCreativeResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionDataIntelligenceResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionDeclineResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionDisplayResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionEarnRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionEmailResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionExpressionResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionFireAsPersonResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionFulfillRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionIncentivizeResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionIncentivizeStatusUpdateResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionRedeemRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionRemoveMembershipResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionRevokeRewardResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionScheduleResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionShareEventResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionSignalResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionSignalV1Response' - $ref: '#/components/schemas/BuiltCampaignControllerActionStepSignalResponse' - $ref: '#/components/schemas/BuiltCampaignControllerActionWebhookResponse' CampaignControllerActionExpressionResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EXPRESSION type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionExpressionResponse' expression: $ref: '#/components/schemas/ExpressionInCampaignControllerActionExpressionResponse' type: object type: object JourneyNamesInCampaignFrontendControllerResponse: description: 'The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal journey names items: type: string title: Static Value type: array uniqueItems: true - 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:{{journeyNames}} 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('journeyNames');} 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 CampaignComponentVariableResponseAsClientKey: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - CLIENT_KEY type: string 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 type: object CampaignComponentVariableResponseAsHtml: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - HTML type: string 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 type: object EventTypesInCampaignControllerTriggerAudienceMembershipEventResponse: description: 'The event types as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event types items: enum: - CREATED - REMOVED - UPDATED type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventTypes}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventTypes');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionDataIntelligenceResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DATA_INTELLIGENCE type: string event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionDataIntelligenceResponse' intelligence_provider: $ref: '#/components/schemas/IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse' profile_risk_update_interval: $ref: '#/components/schemas/ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse' type: object type: object BuiltCampaignComponentResponse: properties: assets: items: $ref: '#/components/schemas/BuiltComponentAssetResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' description: type: string display_name: type: string facets: items: $ref: '#/components/schemas/CampaignComponentFacetResponse' type: array id: readOnly: true type: string install: $ref: '#/components/schemas/InstallInBuiltCampaignComponentResponse' installed_into_socket: type: string name: type: string origin: $ref: '#/components/schemas/ComponentOriginResponse' tags: items: type: string type: array uniqueItems: true type: type: string types: items: type: string type: array updated_date: $ref: '#/components/schemas/ZonedDateTime' upload_version: type: string variables: items: $ref: '#/components/schemas/BuiltCampaignComponentSettingResponse' type: array version: format: int32 type: integer required: - assets - component_ids - component_references - created_date - description - display_name - facets - id - install - installed_into_socket - name - origin - tags - type - types - updated_date - upload_version - variables - version type: object CategoryInCampaignFrontendControllerResponse: description: 'The category as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal category title: Static Value - 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:{{category}} 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('category');} 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 BuiltCampaignFrontendControllerResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/BuiltCampaignControllerActionResponse' type: array aliases: items: type: string type: array category: type: string enabled_on_states: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true id: readOnly: true type: string journey_names: items: type: string type: array uniqueItems: true name: type: string scope: enum: - CLIENT - PRIVATE - PUBLIC type: string send_policy: enum: - ALL - FIRST_ONLY type: string type: enum: - FRONTEND_CONTROLLER type: string type: object required: - actions - aliases - category - component_ids - component_references - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - send_policy - step_builder - triggers - type - updated_date type: object RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse: description: 'The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward action id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDisplayResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DISPLAY type: string body: $ref: '#/components/schemas/BodyInCampaignControllerActionDisplayResponse' headers: $ref: '#/components/schemas/HeadersInCampaignControllerActionDisplayResponse' response: $ref: '#/components/schemas/ResponseInCampaignControllerActionDisplayResponse' type: object type: object DefaultValueInStepDataResponse: description: 'The default value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal default value title: Static Value type: object - 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:{{defaultValue}} 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('defaultValue');} 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 - description: Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{defaultValue}} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('defaultValue');} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionFireAsPersonResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionFireAsPersonResponse' type: object CampaignControllerTriggerAudienceMembershipEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: audience_ids: $ref: '#/components/schemas/AudienceIdsInCampaignControllerTriggerAudienceMembershipEventResponse' event_types: $ref: '#/components/schemas/EventTypesInCampaignControllerTriggerAudienceMembershipEventResponse' trigger_type: enum: - AUDIENCE_MEMBERSHIP_EVENT type: string type: object 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 CampaignControllerActionEmailResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EMAIL type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEmailResponse' zone_name: $ref: '#/components/schemas/ZoneNameInCampaignControllerActionEmailResponse' type: object type: object CampaignControllerActionEarnRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EARN_REWARD type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEarnRewardResponse' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionEarnRewardResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionEarnRewardResponse' reward_action_id: $ref: '#/components/schemas/RewardActionIdInCampaignControllerActionEarnRewardResponse' reward_name: $ref: '#/components/schemas/RewardNameInCampaignControllerActionEarnRewardResponse' reward_supplier_id: $ref: '#/components/schemas/RewardSupplierIdInCampaignControllerActionEarnRewardResponse' slots: $ref: '#/components/schemas/SlotsInCampaignControllerActionEarnRewardResponse' tags: $ref: '#/components/schemas/TagsInCampaignControllerActionEarnRewardResponse' value_of_event_being_rewarded: $ref: '#/components/schemas/ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse' type: object type: object EnInBuiltComponentSettingValues: 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 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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.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 CampaignComponentVariableResponseAsRewardSupplierId: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - REWARD_SUPPLIER_ID type: string 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 type: object DataMapInCampaignControllerActionSignalResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionSignalResponse' type: object BuiltCampaignStepResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' data: items: $ref: '#/components/schemas/BuiltStepDataResponse' type: array enabled: type: boolean id: readOnly: true type: string step_builder: $ref: '#/components/schemas/StepBuilderInBuiltCampaignStepResponseBase' triggers: items: $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponse' type: array type: enum: - CONTROLLER - FRONTEND_CONTROLLER - JOURNEY_ENTRY type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object BuiltCampaignComponentVariableResponseAsWebhookId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - WEBHOOK_ID type: string type: object type: object CampaignComponentSettingResponse: discriminator: mapping: ADMIN_ICON: '#/components/schemas/CampaignComponentVariableResponseAsAdminIcon' AUDIENCE_ID: '#/components/schemas/CampaignComponentVariableResponseAsAudienceId' AUDIENCE_ID_LIST: '#/components/schemas/CampaignComponentVariableResponseAsAudienceIdList' BOOLEAN: '#/components/schemas/CampaignComponentVariableResponseAsBoolean' BROWSER_SIDE_JAVASCRIPT: '#/components/schemas/CampaignComponentVariableResponseAsBrowserSideJavascript' CLIENT_DOMAIN_ID_LIST: '#/components/schemas/CampaignComponentVariableResponseAsClientDomainIdList' CLIENT_KEY: '#/components/schemas/CampaignComponentVariableResponseAsClientKey' CLIENT_KEY_FLOW: '#/components/schemas/CampaignComponentClientKeyFlowVariableResponse' COLOR: '#/components/schemas/CampaignComponentVariableResponseAsColor' COMPONENT_ID: '#/components/schemas/CampaignComponentComponentIdVariableResponse' COMPONENT_SETTING_LOOKUP: '#/components/schemas/CampaignComponentComponentSettingLookupVariableResponse' CSS: '#/components/schemas/CampaignComponentVariableResponseAsCss' DELAY: '#/components/schemas/CampaignComponentVariableResponseAsDelay' DELAY_LIST: '#/components/schemas/CampaignComponentVariableResponseAsDelayList' ENUM: '#/components/schemas/CampaignComponentEnumVariableResponse' ENUM_LIST: '#/components/schemas/CampaignComponentEnumListVariableResponse' EXTOLE_CLIENT_KEY: '#/components/schemas/CampaignComponentVariableResponseAsExtoleClientKey' FONT: '#/components/schemas/CampaignComponentVariableResponseAsFont' GLOB_COMPONENT_PATH: '#/components/schemas/CampaignComponentVariableResponseAsGlobComponentPath' HTML: '#/components/schemas/CampaignComponentVariableResponseAsHtml' IMAGE: '#/components/schemas/CampaignComponentVariableResponseAsImage' INTEGER: '#/components/schemas/CampaignComponentVariableResponseAsInteger' INTEGER_LIST: '#/components/schemas/CampaignComponentVariableResponseAsIntegerList' JSON: '#/components/schemas/CampaignComponentVariableResponseAsJson' MULTI_SOCKET: '#/components/schemas/CampaignComponentSocketResponseAsMultiSocket' PARTNER_ENUM: '#/components/schemas/CampaignComponentPartnerEnumVariableResponse' PARTNER_ENUM_LIST: '#/components/schemas/CampaignComponentPartnerEnumListVariableResponse' PERSON_KEY_NAME: '#/components/schemas/CampaignComponentVariableResponseAsPersonKeyName' REWARD_SUPPLIER_ID: '#/components/schemas/CampaignComponentVariableResponseAsRewardSupplierId' REWARD_SUPPLIER_ID_LIST: '#/components/schemas/CampaignComponentRewardSupplierIdListVariableResponse' SOCKET: '#/components/schemas/CampaignComponentSocketResponseAsSocket' STRING: '#/components/schemas/CampaignComponentVariableResponseAsString' STRING_LIST: '#/components/schemas/CampaignComponentVariableResponseAsStringList' STRING_MAP: '#/components/schemas/CampaignComponentStringMapVariableResponse' URL: '#/components/schemas/CampaignComponentVariableResponseAsUrl' WEBHOOK_ID: '#/components/schemas/CampaignComponentVariableResponseAsWebhookId' propertyName: type oneOf: - $ref: '#/components/schemas/CampaignComponentVariableResponseAsAdminIcon' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsAudienceId' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsAudienceIdList' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsBoolean' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsBrowserSideJavascript' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsClientDomainIdList' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsClientKey' - $ref: '#/components/schemas/CampaignComponentClientKeyFlowVariableResponse' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsColor' - $ref: '#/components/schemas/CampaignComponentComponentIdVariableResponse' - $ref: '#/components/schemas/CampaignComponentComponentSettingLookupVariableResponse' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsCss' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsDelay' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsDelayList' - $ref: '#/components/schemas/CampaignComponentEnumVariableResponse' - $ref: '#/components/schemas/CampaignComponentEnumListVariableResponse' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsExtoleClientKey' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsFont' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsGlobComponentPath' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsHtml' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsImage' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsInteger' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsIntegerList' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsJson' - $ref: '#/components/schemas/CampaignComponentSocketResponseAsMultiSocket' - $ref: '#/components/schemas/CampaignComponentPartnerEnumVariableResponse' - $ref: '#/components/schemas/CampaignComponentPartnerEnumListVariableResponse' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsPersonKeyName' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsRewardSupplierId' - $ref: '#/components/schemas/CampaignComponentRewardSupplierIdListVariableResponse' - $ref: '#/components/schemas/CampaignComponentSocketResponseAsSocket' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsString' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsStringList' - $ref: '#/components/schemas/CampaignComponentStringMapVariableResponse' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsUrl' - $ref: '#/components/schemas/CampaignComponentVariableResponseAsWebhookId' required: - description - display_name - name - priority - tags - type DataMapInBuiltCampaignControllerActionSignalResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionSignalResponse' type: object CampaignComponentPartnerEnumListVariableResponse: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - PARTNER_ENUM_LIST type: string 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 webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignComponentPartnerEnumListVariableResponse' options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object description: Stored campaign component partner enum list variable definition. Fields `description` and `webhook_id` are unevaluated and appear in buildtime-evaluatable form. required: - description - display_name - name - options - priority - source - tags - type - values - webhook_id type: object EnabledOnStatesInCampaignControllerResponse: description: 'The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled on states items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string title: Static Value type: array uniqueItems: true - 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:{{enabledOnStates}} 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('enabledOnStates');} 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 ComponentTypeSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: component_type: type: string type: enum: - COMPONENT_TYPE type: string type: object required: - component_type - type type: object BuiltCampaignControllerActionExpressionResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EXPRESSION type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionExpressionResponse' expression: $ref: '#/components/schemas/ExpressionInBuiltCampaignControllerActionExpressionResponse' type: object required: - action_id - action_type - component_ids - component_references - data - enabled - expression - quality type: object ReviewStatusInCampaignControllerActionIncentivizeResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal review status enum: - EVALUATING - PENDING title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ValueInBuiltStepDataResponse: description: 'The value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value title: Static Value type: object - description: Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: StepDataContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MonthDay: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#appendix-A) month-day date.' example: --10-24 pattern: ^--(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$ type: string DelaysInCampaignControllerActionScheduleResponse: description: 'The delays as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{delays}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('delays');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInCampaignControllerTriggerAudienceMembershipResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: AudienceMembershipTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: AudienceMembershipTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignComponentVariableResponseAsBoolean: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - BOOLEAN type: string type: object type: object BuiltCampaignControllerResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/BuiltCampaignControllerActionResponse' type: array aliases: items: type: string type: array controller_id: type: string enabled_on_states: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true id: readOnly: true type: string journey_names: items: type: string type: array uniqueItems: true name: type: string scope: enum: - CLIENT - PRIVATE - PUBLIC type: string selectors: items: enum: - BEST_REFERRAL - BEST_REFERRAL_SAME_PROGRAM - MATCHING_CAMPAIGN - TARGET type: string type: array send_policy: enum: - ALL - FIRST_ONLY type: string type: enum: - CONTROLLER type: string type: object required: - actions - aliases - component_ids - component_references - controller_id - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - selectors - send_policy - step_builder - triggers - type - updated_date type: object CampaignControllerTriggerDataIntelligenceEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: event_name: $ref: '#/components/schemas/EventNameInCampaignControllerTriggerDataIntelligenceEventResponse' trigger_type: enum: - DATA_INTELLIGENCE_EVENT type: string type: object type: object PersonIdInCampaignControllerActionFireAsPersonResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{personId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerTriggerResponse: description: Stored campaign controller trigger definition. Fields `trigger_phase`, `trigger_name`, `parent_trigger_group_name`, `trigger_description`, `enabled`, and `negated` are unevaluated and appear in buildtime-evaluatable form. discriminator: mapping: ACCESS: '#/components/schemas/CampaignControllerTriggerAccessResponse' AUDIENCE_MEMBERSHIP: '#/components/schemas/CampaignControllerTriggerAudienceMembershipResponse' AUDIENCE_MEMBERSHIP_EVENT: '#/components/schemas/CampaignControllerTriggerAudienceMembershipEventResponse' CLIENT_DOMAIN: '#/components/schemas/CampaignControllerTriggerClientDomainResponse' DATA_INTELLIGENCE_EVENT: '#/components/schemas/CampaignControllerTriggerDataIntelligenceEventResponse' EVENT: '#/components/schemas/CampaignControllerTriggerEventResponse' EVENT_TARGETING: '#/components/schemas/CampaignControllerTriggerEventTargetingResponse' EXPRESSION: '#/components/schemas/CampaignControllerTriggerExpressionResponse' GROUP: '#/components/schemas/CampaignControllerTriggerGroupResponse' HAS_IDENTITY: '#/components/schemas/CampaignControllerTriggerHasIdentityResponse' HAS_PRIOR_REWARD: '#/components/schemas/CampaignControllerTriggerHasPriorRewardResponse' HAS_PRIOR_STEP: '#/components/schemas/CampaignControllerTriggerHasPriorStepResponse' JOURNEY_CHECK: '#/components/schemas/CampaignControllerTriggerJourneyCheckResponse' LEGACY_LABEL_TARGETING: '#/components/schemas/CampaignControllerTriggerLegacyLabelTargetingResponse' LEGACY_QUALITY: '#/components/schemas/CampaignControllerTriggerLegacyQualityResponse' MAXMIND: '#/components/schemas/CampaignControllerTriggerMaxMindResponse' REFERRED_BY_EVENT: '#/components/schemas/CampaignControllerTriggerReferredByEventResponse' REWARD_EVENT: '#/components/schemas/CampaignControllerTriggerRewardEventResponse' SCORE: '#/components/schemas/CampaignControllerTriggerScoreResponse' SEND_REWARD_EVENT: '#/components/schemas/CampaignControllerTriggerSendRewardEventResponse' SHARE: '#/components/schemas/CampaignControllerTriggerShareResponse' STEP_EVENT: '#/components/schemas/CampaignControllerTriggerStepEventResponse' STICKY_JOURNEY: '#/components/schemas/CampaignControllerTriggerStickyJourneyResponse' TARGETING: '#/components/schemas/CampaignControllerTriggerTargetingResponse' ZONE_STATE: '#/components/schemas/CampaignControllerTriggerZoneStateResponse' propertyName: trigger_type oneOf: - $ref: '#/components/schemas/CampaignControllerTriggerAccessResponse' - $ref: '#/components/schemas/CampaignControllerTriggerAudienceMembershipResponse' - $ref: '#/components/schemas/CampaignControllerTriggerAudienceMembershipEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerClientDomainResponse' - $ref: '#/components/schemas/CampaignControllerTriggerDataIntelligenceEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerEventTargetingResponse' - $ref: '#/components/schemas/CampaignControllerTriggerExpressionResponse' - $ref: '#/components/schemas/CampaignControllerTriggerGroupResponse' - $ref: '#/components/schemas/CampaignControllerTriggerHasIdentityResponse' - $ref: '#/components/schemas/CampaignControllerTriggerHasPriorRewardResponse' - $ref: '#/components/schemas/CampaignControllerTriggerHasPriorStepResponse' - $ref: '#/components/schemas/CampaignControllerTriggerJourneyCheckResponse' - $ref: '#/components/schemas/CampaignControllerTriggerLegacyLabelTargetingResponse' - $ref: '#/components/schemas/CampaignControllerTriggerLegacyQualityResponse' - $ref: '#/components/schemas/CampaignControllerTriggerMaxMindResponse' - $ref: '#/components/schemas/CampaignControllerTriggerReferredByEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerRewardEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerScoreResponse' - $ref: '#/components/schemas/CampaignControllerTriggerSendRewardEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerShareResponse' - $ref: '#/components/schemas/CampaignControllerTriggerStepEventResponse' - $ref: '#/components/schemas/CampaignControllerTriggerStickyJourneyResponse' - $ref: '#/components/schemas/CampaignControllerTriggerTargetingResponse' - $ref: '#/components/schemas/CampaignControllerTriggerZoneStateResponse' required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type BuiltStepDataResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array default_value: $ref: '#/components/schemas/DefaultValueInBuiltStepDataResponse' dimension: type: boolean enabled: type: boolean id: readOnly: true type: string key_type: enum: - NONE - PARTNER_EVENT_KEY - PARTNER_PROFILE_KEY - UNIQUE_PARTNER_EVENT_KEY - VALUE type: string name: type: string persist_types: items: enum: - JOURNEY - PROFILE - STEP type: string type: array scope: enum: - CLIENT - PRIVATE - PUBLIC type: string value: $ref: '#/components/schemas/ValueInBuiltStepDataResponse' required: - component_ids - component_references - default_value - dimension - enabled - id - key_type - name - persist_types - scope - value type: object FireAsPersonIdentification: discriminator: mapping: EMAIL: '#/components/schemas/EmailFireAsPersonIdentification' PARTNER_EVENT_ID: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' PARTNER_USER_ID: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' PERSON_ID: '#/components/schemas/PersonIdFireAsPersonIdentification' propertyName: person_identification_type oneOf: - $ref: '#/components/schemas/EmailFireAsPersonIdentification' - $ref: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' - $ref: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' - $ref: '#/components/schemas/PersonIdFireAsPersonIdentification' BuiltCampaignControllerTriggerRewardEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array uniqueItems: true reward_states: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED type: string type: array uniqueItems: true slots: items: type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true trigger_type: enum: - REWARD_EVENT type: string type: object required: - component_ids - component_references - enabled - event_names - negated - parent_trigger_group_name - reward_states - slots - tags - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object CampaignComponentVariableResponseAsBrowserSideJavascript: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - BROWSER_SIDE_JAVASCRIPT type: string 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 type: object DescriptionInCampaignComponentVariableResponse: description: 'The description as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal description title: Static Value type: string - description: Handlebars expression with [VariableDescriptionBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableDescriptionBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: VariableDescriptionBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableDescriptionBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [VariableDescriptionBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableDescriptionBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: VariableDescriptionBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariableDescriptionBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerExpressionResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: data: additionalProperties: type: string type: object expression: $ref: '#/components/schemas/ExpressionInBuiltCampaignControllerTriggerExpressionResponse' trigger_type: enum: - EXPRESSION type: string type: object type: object OperatorInCampaignControllerTriggerGroupResponse: description: 'The operator as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal operator enum: - AND - OR title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{operator}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('operator');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsFont: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - FONT type: string type: object type: object CampaignComponentVariableResponseAsAudienceId: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - AUDIENCE_ID type: string 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 type: object CampaignControllerTriggerAudienceMembershipResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: having_any_audience_id: $ref: '#/components/schemas/HavingAnyAudienceIdInCampaignControllerTriggerAudienceMembershipResponse' person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerTriggerAudienceMembershipResponse' trigger_type: enum: - AUDIENCE_MEMBERSHIP type: string type: object type: object BuiltCampaignComponentVariableResponseAsImage: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - IMAGE type: string type: object type: object CampaignControllerTriggerLegacyLabelTargetingResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - LEGACY_LABEL_TARGETING type: string type: object type: object BuiltCampaignComponentVariableResponseAsExtoleClientKey: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - EXTOLE_CLIENT_KEY type: string type: object type: object CampaignControllerTriggerTargetingResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: scope: $ref: '#/components/schemas/ScopeInCampaignControllerTriggerTargetingResponse' trigger_type: enum: - TARGETING type: string type: object type: object SequenceInCampaignFlowStepResponse: description: 'The sequence as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal sequence title: Static Value type: number - 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:{{sequence}} 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('sequence');} 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 BuiltCampaignControllerActionDisplayResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DISPLAY type: string body: $ref: '#/components/schemas/BodyInBuiltCampaignControllerActionDisplayResponse' headers: $ref: '#/components/schemas/HeadersInBuiltCampaignControllerActionDisplayResponse' response: $ref: '#/components/schemas/ResponseInBuiltCampaignControllerActionDisplayResponse' type: object type: object PartnerEnumListVariableOptionResponse: properties: id: type: string name: type: string type: object BuiltCampaignComponentVariableResponseAsClientDomainIdList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_DOMAIN_ID_LIST type: string type: object type: object CampaignControllerTriggerClientDomainResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: client_domain_ids: $ref: '#/components/schemas/ClientDomainIdsInCampaignControllerTriggerClientDomainResponse' trigger_type: enum: - CLIENT_DOMAIN type: string type: object type: object ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal review status title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionEmailResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EMAIL type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionEmailResponse' zone_name: type: string type: object type: object DatesInCampaignControllerActionScheduleResponse: description: 'The dates as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{dates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('dates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DisplayNameInCampaignComponentResponse: description: 'The display name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal display name 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:{{displayName}} 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('displayName');} 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 CampaignControllerResponse: allOf: - $ref: '#/components/schemas/CampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/CampaignControllerActionResponse' type: array aliases: $ref: '#/components/schemas/AliasesInCampaignControllerResponse' controller_id: type: string enabled_on_states: $ref: '#/components/schemas/EnabledOnStatesInCampaignControllerResponse' id: readOnly: true type: string journey_names: $ref: '#/components/schemas/JourneyNamesInCampaignControllerResponse' name: $ref: '#/components/schemas/NameInCampaignControllerResponse' scope: $ref: '#/components/schemas/ScopeInCampaignControllerResponse' selectors: $ref: '#/components/schemas/SelectorsInCampaignControllerResponse' send_policy: $ref: '#/components/schemas/SendPolicyInCampaignControllerResponse' type: enum: - CONTROLLER type: string type: object description: Stored campaign controller definition. Fields `enabled`, `name`, `scope`, `enabled_on_states`, `selectors`, `aliases`, `journey_names`, `send_policy`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. required: - actions - aliases - component_ids - component_references - controller_id - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - selectors - send_policy - step_builder - triggers - type - updated_date type: object BuiltComponentPartnerEnumListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PARTNER_ENUM_LIST type: string webhook_id: type: string options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object required: - description - display_name - name - options - priority - source - source_component_id - source_version - tags - type - values - webhook_id type: object CampaignComponentVariableResponseAsStringList: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - STRING_LIST type: string 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 type: object CampaignControllerActionSignalResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionSignalResponse' name: $ref: '#/components/schemas/NameInCampaignControllerActionSignalResponse' signal_polling_id: $ref: '#/components/schemas/SignalPollingIdInCampaignControllerActionSignalResponse' type: object type: object CampaignMakeLatestRequest: properties: message: nullable: true type: string version: type: string type: object NegatedInCampaignControllerTriggerResponseBase: description: 'The negated as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal negated title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{negated}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('negated');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FilterStatesInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter states as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter states items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED - SENT type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterStates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterStates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PersonIdInBuiltCampaignControllerTriggerHasPriorStepResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: type: boolean negated: type: boolean parent_trigger_group_name: type: string trigger_description: type: string trigger_id: type: string trigger_name: type: string trigger_phase: enum: - MATCHING - QUALIFYING - QUALITY type: string trigger_type: enum: - ACCESS - AUDIENCE_MEMBERSHIP - AUDIENCE_MEMBERSHIP_EVENT - CLIENT_DOMAIN - DATA_INTELLIGENCE_EVENT - EVENT - EVENT_TARGETING - EXPRESSION - GROUP - HAS_IDENTITY - HAS_PRIOR_REWARD - HAS_PRIOR_STEP - JOURNEY_CHECK - LEGACY_LABEL_TARGETING - LEGACY_QUALITY - MAXMIND - REFERRED_BY_EVENT - REWARD_EVENT - SCORE - SEND_REWARD_EVENT - SHARE - STEP_EVENT - STICKY_JOURNEY - TARGETING - ZONE_STATE type: string type: object HeadersInBuiltCampaignControllerActionDisplayResponse: description: 'The headers as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: string description: Literal headers title: Static Value type: object - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string AliasesInCampaignControllerResponse: description: 'The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal aliases items: type: string title: Static Value type: array uniqueItems: true - 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:{{aliases}} 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('aliases');} 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 IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse: description: 'The incentivize action type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal incentivize action type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{incentivizeActionType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('incentivizeActionType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string MessageInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The message as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal message title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{message}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('message');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionExpressionResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionExpressionResponse' type: object BuiltCampaignControllerTriggerHasPriorRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: count_matches: items: format: int32 type: integer type: array uniqueItems: true count_max: format: int32 type: integer count_min: format: int32 type: integer filter_expressions: items: type: string type: array uniqueItems: true filter_face_value_types: items: enum: - AUD - BRL - CAD - CNY - EUR - GBP - HKD - INR - JPY - KRW - MONTH - MXN - NZD - PERCENT_OFF - POINTS - TRY - TWD - USD type: string type: array uniqueItems: true filter_max_age: $ref: '#/components/schemas/Duration' filter_max_date: $ref: '#/components/schemas/ZonedDateTime' filter_min_age: $ref: '#/components/schemas/Duration' filter_min_date: $ref: '#/components/schemas/ZonedDateTime' filter_names: items: type: string type: array uniqueItems: true filter_reward_supplier_ids: items: type: string type: array uniqueItems: true filter_scope: enum: - CAMPAIGN - CLIENT - JOURNEY - PROGRAM type: string filter_states: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED - SENT type: string type: array uniqueItems: true filter_tags: items: type: string type: array uniqueItems: true sum_of_face_value_max: type: number sum_of_face_value_min: type: number tax_year_start: $ref: '#/components/schemas/MonthDay' trigger_type: enum: - HAS_PRIOR_REWARD type: string type: object required: - component_ids - component_references - count_matches - count_max - count_min - enabled - filter_expressions - filter_face_value_types - filter_max_age - filter_max_date - filter_min_age - filter_min_date - filter_names - filter_reward_supplier_ids - filter_scope - filter_states - filter_tags - negated - parent_trigger_group_name - sum_of_face_value_max - sum_of_face_value_min - tax_year_start - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExpressionInBuiltCampaignControllerTriggerExpressionResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal expression title: Static Value type: boolean - description: Handlebars expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerEventTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: targeting_attributes: additionalProperties: type: string type: object trigger_type: enum: - EVENT_TARGETING type: string type: object type: object CampaignComponentVariableResponseAsString: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - STRING type: string 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 type: object CountMaxInCampaignControllerTriggerHasPriorRewardResponse: description: 'The count max as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal count max format: int32 title: Static Value type: integer - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{countMax}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('countMax');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string UnitInCampaignFlowStepMetricResponse: description: 'The unit as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal unit title: Static Value - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{unit}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('unit');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FilterMinAgeInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter min age as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Duration' description: Literal filter min age title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMinAge}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMinAge');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse: description: 'The intelligence provider as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal intelligence provider enum: - EMAIL_AGE - MAXMIND - NOOP title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{intelligenceProvider}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('intelligenceProvider');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ExpressionInCampaignControllerActionExpressionResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal expression title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string StepNameInCampaignFlowStepResponse: description: 'The step name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal step name title: Static Value - 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:{{stepName}} 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('stepName');} 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 JourneyNameInCampaignControllerTriggerJourneyCheckResponse: description: 'The journey name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal journey name title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{journeyName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('journeyName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsPersonKeyName: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - PERSON_KEY_NAME type: string 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 type: object CampaignControllerTriggerResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerTriggerResponseBase' negated: $ref: '#/components/schemas/NegatedInCampaignControllerTriggerResponseBase' parent_trigger_group_name: $ref: '#/components/schemas/ParentTriggerGroupNameInCampaignControllerTriggerResponseBase' trigger_description: $ref: '#/components/schemas/TriggerDescriptionInCampaignControllerTriggerResponseBase' trigger_id: type: string trigger_name: $ref: '#/components/schemas/TriggerNameInCampaignControllerTriggerResponseBase' trigger_phase: $ref: '#/components/schemas/TriggerPhaseInCampaignControllerTriggerResponseBase' trigger_type: enum: - ACCESS - AUDIENCE_MEMBERSHIP - AUDIENCE_MEMBERSHIP_EVENT - CLIENT_DOMAIN - DATA_INTELLIGENCE_EVENT - EVENT - EVENT_TARGETING - EXPRESSION - GROUP - HAS_IDENTITY - HAS_PRIOR_REWARD - HAS_PRIOR_STEP - JOURNEY_CHECK - LEGACY_LABEL_TARGETING - LEGACY_QUALITY - MAXMIND - REFERRED_BY_EVENT - REWARD_EVENT - SCORE - SEND_REWARD_EVENT - SHARE - STEP_EVENT - STICKY_JOURNEY - TARGETING - ZONE_STATE type: string type: object StepDataResponse: description: Stored step data definition. Fields `name`, `value`, `scope`, `dimension`, `persist_types`, `default_value`, `key_type`, and `enabled` are unevaluated and appear in buildtime-evaluatable form. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array default_value: $ref: '#/components/schemas/DefaultValueInStepDataResponse' dimension: $ref: '#/components/schemas/DimensionInStepDataResponse' enabled: $ref: '#/components/schemas/EnabledInStepDataResponse' id: readOnly: true type: string key_type: $ref: '#/components/schemas/KeyTypeInStepDataResponse' name: $ref: '#/components/schemas/NameInStepDataResponse' persist_types: $ref: '#/components/schemas/PersistTypesInStepDataResponse' scope: $ref: '#/components/schemas/ScopeInStepDataResponse' value: $ref: '#/components/schemas/ValueInStepDataResponse' required: - component_ids - component_references - default_value - dimension - enabled - id - key_type - name - persist_types - scope - value type: object AllowHighRiskEmailInCampaignControllerTriggerMaxMindResponse: description: 'The allow high risk email as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal allow high risk email title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{allowHighRiskEmail}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('allowHighRiskEmail');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsGlobComponentPath: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - GLOB_COMPONENT_PATH type: string type: object type: object BuiltCampaignControllerActionIncentivizeStatusUpdateResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - INCENTIVIZE_STATUS_UPDATE type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' event_type: $ref: '#/components/schemas/EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' message: $ref: '#/components/schemas/MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' move_to_pending: type: boolean partner_event_id: $ref: '#/components/schemas/PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' review_status: $ref: '#/components/schemas/ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' type: object type: object BuiltCampaignFlowStepAppTypeResponse: properties: name: type: string type: object TagsInCampaignControllerTriggerRewardEventResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardNameInCampaignControllerActionEarnRewardResponse: description: 'The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal reward name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerTriggerEventTargetingResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: targeting_attributes: $ref: '#/components/schemas/TargetingAttributesInCampaignControllerTriggerEventTargetingResponse' trigger_type: enum: - EVENT_TARGETING type: string type: object type: object CampaignControllerActionRevokeRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REVOKE_REWARD type: string message: type: string reward_id: type: string type: object type: object BuiltCampaignComponentVariableResponseAsInteger: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - INTEGER type: string type: object type: object BodyInCampaignControllerActionDisplayResponse: description: 'The body as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal body title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{body}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('body');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionApproveResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - APPROVE type: string cause_type: type: string event_type: type: string force: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string reward_tags: $ref: '#/components/schemas/RewardTagsInCampaignControllerActionApproveResponse' type: object type: object InstallInBuiltCampaignComponentResponse: description: 'The install as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal install title: Static Value type: object - description: Handlebars expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: handlebars@installtime:{{install}} externalDocs: description: ComponentInstalltimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^handlebars@installtime:.* title: Installtime - Handlebars type: string - description: Javascript expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: javascript@installtime:function() { return context.getVariableContext().get('install');} externalDocs: description: ComponentInstalltimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^javascript@installtime:.* title: Installtime - Javascript type: string BuiltCampaignControllerActionResponseBase: properties: action_id: type: string action_type: enum: - APPROVE - CANCEL_REWARD - CREATE_MEMBERSHIP - CREATIVE - DATA_INTELLIGENCE - DECLINE - DISPLAY - EARN_REWARD - EMAIL - EXPRESSION - FIRE_AS_PERSON - FULFILL_REWARD - INCENTIVIZE - INCENTIVIZE_STATUS_UPDATE - REDEEM_REWARD - REMOVE_MEMBERSHIP - REVOKE_REWARD - SCHEDULE - SHARE_EVENT - SIGNAL - SIGNAL_V1 - STEP_SIGNAL - WEBHOOK type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: type: boolean quality: enum: - ALWAYS - HIGH - LOW type: string type: object FilterPartnerEventIdInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/PartnerEventId' description: Literal filter partner event id title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterPartnerEventId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterPartnerEventId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInStepDataResponse: description: 'The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled title: Static Value type: boolean - 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:{{enabled}} 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('enabled');} 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 EventNameInCampaignControllerActionDataIntelligenceResponse: description: 'The event name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionScheduleResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SCHEDULE type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionScheduleResponse' dates: $ref: '#/components/schemas/DatesInBuiltCampaignControllerActionScheduleResponse' delays: $ref: '#/components/schemas/DelaysInBuiltCampaignControllerActionScheduleResponse' extra_data: $ref: '#/components/schemas/ExtraDataInBuiltCampaignControllerActionScheduleResponse' force: type: boolean schedule_name: $ref: '#/components/schemas/ScheduleNameInBuiltCampaignControllerActionScheduleResponse' type: object required: - action_id - action_type - component_ids - component_references - data - dates - delays - enabled - extra_data - force - quality - schedule_name type: object ScopeInCampaignControllerTriggerTargetingResponse: description: 'The scope as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal scope enum: - CAMPAIGN - JOURNEY - PROGRAM title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{scope}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('scope');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsIntegerList: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - INTEGER_LIST type: string 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 type: object CampaignControllerTriggerRewardEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: event_names: $ref: '#/components/schemas/EventNamesInCampaignControllerTriggerRewardEventResponse' reward_states: $ref: '#/components/schemas/RewardStatesInCampaignControllerTriggerRewardEventResponse' slots: $ref: '#/components/schemas/SlotsInCampaignControllerTriggerRewardEventResponse' tags: $ref: '#/components/schemas/TagsInCampaignControllerTriggerRewardEventResponse' trigger_type: enum: - REWARD_EVENT type: string type: object type: object BuiltCampaignComponentVariableResponseAsAudienceIdList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - AUDIENCE_ID_LIST type: string type: object type: object IncentiveResponse: properties: id: readOnly: true type: string quality_rules: items: $ref: '#/components/schemas/QualityRuleResponse' type: array reward_rules: items: $ref: '#/components/schemas/RewardRuleResponse' type: array transition_rules: items: $ref: '#/components/schemas/TransitionRuleResponse' type: array required: - id - quality_rules - reward_rules - transition_rules type: object CampaignControllerTriggerStepEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: event_names: $ref: '#/components/schemas/EventNamesInCampaignControllerTriggerStepEventResponse' having_any_data_name: $ref: '#/components/schemas/HavingAnyDataNameInCampaignControllerTriggerStepEventResponse' trigger_type: enum: - STEP_EVENT type: string type: object type: object BuiltCampaignControllerTriggerSendRewardEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: reward_names: items: type: string type: array uniqueItems: true reward_states: items: enum: - FULFILLED - SENT type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true trigger_type: enum: - SEND_REWARD_EVENT type: string type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - reward_names - reward_states - tags - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object BuiltCampaignControllerTriggerLegacyLabelTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - LEGACY_LABEL_TARGETING type: string required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object BuiltCampaignControllerTriggerLegacyQualityResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string trigger_type: enum: - LEGACY_QUALITY type: string type: object type: object SendPolicyInCampaignFrontendControllerResponse: description: 'The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal send policy enum: - ALL - FIRST_ONLY 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:{{sendPolicy}} 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('sendPolicy');} 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 RewardStatesInCampaignControllerTriggerSendRewardEventResponse: description: 'The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward states items: enum: - FULFILLED - SENT type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardStates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardStates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string WebhookIdInCampaignControllerActionWebhookResponse: description: 'The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal webhook id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{webhookId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('webhookId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string TagsInCampaignFlowStepResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardSupplierIdInCampaignControllerActionEarnRewardResponse: description: 'The reward supplier id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward supplier id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardSupplierId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardSupplierId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInBuiltCampaignControllerActionSignalResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ZonedDateTime: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.' example: '2025-10-24T02:00:00-07:00' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string CampaignControllerActionCreateMembershipResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CREATE_MEMBERSHIP type: string audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionCreateMembershipResponse' type: object type: object EventTimeInCampaignControllerActionFulfillRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FilterMinValueInCampaignControllerTriggerHasPriorStepResponse: description: 'The filter min value as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal filter min value title: Static Value type: number - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMinValue}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMinValue');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionFireAsPersonResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - FIRE_AS_PERSON type: string as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionFireAsPersonResponse' event_name: type: string event_time: $ref: '#/components/schemas/EventTimeInBuiltCampaignControllerActionFireAsPersonResponse' extra_data: $ref: '#/components/schemas/ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInBuiltCampaignControllerActionFireAsPersonResponse' type: object type: object BuiltCampaignFlowStepMetricResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: nullable: true type: string expression: type: string id: readOnly: true type: string name: type: string tags: items: type: string type: array uniqueItems: true unit: type: string required: - component_ids - component_references - description - expression - id - name - tags - unit type: object ExpressionInCampaignControllerTriggerExpressionResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal expression title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionApproveResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - APPROVE type: string cause_type: type: string event_type: type: string force: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string reward_tags: $ref: '#/components/schemas/RewardTagsInBuiltCampaignControllerActionApproveResponse' type: object required: - action_id - action_type - cause_type - component_ids - component_references - enabled - event_type - force - legacy_action_id - note - partner_event_id - polling_id - polling_name - quality - reward_tags type: object DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' type: object BuiltCampaignControllerActionRemoveMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REMOVE_MEMBERSHIP type: string audience_id: type: string type: object required: - action_id - action_type - audience_id - component_ids - component_references - enabled - quality type: object TagsInCampaignControllerTriggerSendRewardEventResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsAdminIcon: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ADMIN_ICON type: string type: object type: object BuiltCampaignComponentVariableResponseAsJson: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - JSON type: string type: object type: object CampaignComponentVariableResponseAsJson: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - JSON type: string 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 type: object CampaignProgramLabelRenameRequest: properties: program_label: type: string required: - program_label type: object PersonIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PERSON_ID type: string type: object CampaignControllerTriggerHasIdentityResponse: allOf: - $ref: '#/components/schemas/CampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - HAS_IDENTITY type: string type: object type: object HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse: description: 'The having all names as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal having all names items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{havingAllNames}} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('havingAllNames');} externalDocs: description: HasPriorStepTriggerContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionIncentivizeResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FilterMinDateInCampaignControllerTriggerHasPriorRewardResponse: description: 'The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal filter min date title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{filterMinDate}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('filterMinDate');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignComponentVariableResponseAsDelayList: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - DELAY_LIST type: string 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 type: object NameInJourneyKeyResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - 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:{{name}} 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('name');} 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 VariantSelectorInCampaignResponse: description: 'The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal variant selector title: Static Value - 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:{{variantSelector}} 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('variantSelector');} 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 - description: Handlebars expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: handlebars@runtime:{{variantSelector}} externalDocs: description: VariantSelectionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: javascript@runtime:function() { return context.get('variantSelector');} externalDocs: description: VariantSelectionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignFlowStepMetricResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionFireAsPersonResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The event type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignFlowStepResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: AllFlowStepsBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DeweyDecimal: example: '10' type: string BuiltCampaignComponentSettingResponse: discriminator: mapping: ADMIN_ICON: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAdminIcon' AUDIENCE_ID: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceId' AUDIENCE_ID_LIST: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceIdList' BOOLEAN: '#/components/schemas/BuiltCampaignComponentVariableResponseAsBoolean' BROWSER_SIDE_JAVASCRIPT: '#/components/schemas/BuiltCampaignComponentVariableResponseAsBrowserSideJavascript' CLIENT_DOMAIN_ID_LIST: '#/components/schemas/BuiltCampaignComponentVariableResponseAsClientDomainIdList' CLIENT_KEY: '#/components/schemas/BuiltCampaignComponentVariableResponseAsClientKey' CLIENT_KEY_FLOW: '#/components/schemas/BuiltComponentClientKeyFlowVariableResponse' COLOR: '#/components/schemas/BuiltCampaignComponentVariableResponseAsColor' COMPONENT_ID: '#/components/schemas/BuiltComponentComponentIdVariableResponse' COMPONENT_SETTING_LOOKUP: '#/components/schemas/BuiltComponentComponentSettingLookupVariableResponse' CSS: '#/components/schemas/BuiltCampaignComponentVariableResponseAsCss' DELAY: '#/components/schemas/BuiltCampaignComponentVariableResponseAsDelay' DELAY_LIST: '#/components/schemas/BuiltCampaignComponentVariableResponseAsDelayList' ENUM: '#/components/schemas/BuiltComponentEnumVariableResponse' ENUM_LIST: '#/components/schemas/BuiltComponentEnumListVariableResponse' EXTOLE_CLIENT_KEY: '#/components/schemas/BuiltCampaignComponentVariableResponseAsExtoleClientKey' FONT: '#/components/schemas/BuiltCampaignComponentVariableResponseAsFont' GLOB_COMPONENT_PATH: '#/components/schemas/BuiltCampaignComponentVariableResponseAsGlobComponentPath' HTML: '#/components/schemas/BuiltCampaignComponentVariableResponseAsHtml' IMAGE: '#/components/schemas/BuiltCampaignComponentVariableResponseAsImage' INTEGER: '#/components/schemas/BuiltCampaignComponentVariableResponseAsInteger' INTEGER_LIST: '#/components/schemas/BuiltCampaignComponentVariableResponseAsIntegerList' JSON: '#/components/schemas/BuiltCampaignComponentVariableResponseAsJson' MULTI_SOCKET: '#/components/schemas/BuiltComponentSocketResponseAsMultiSocket' PARTNER_ENUM: '#/components/schemas/BuiltComponentPartnerEnumVariableResponse' PARTNER_ENUM_LIST: '#/components/schemas/BuiltComponentPartnerEnumListVariableResponse' PERSON_KEY_NAME: '#/components/schemas/BuiltCampaignComponentVariableResponseAsPersonKeyName' REWARD_SUPPLIER_ID: '#/components/schemas/BuiltCampaignComponentVariableResponseAsRewardSupplierId' REWARD_SUPPLIER_ID_LIST: '#/components/schemas/BuiltComponentRewardSupplierIdListVariableResponse' SOCKET: '#/components/schemas/BuiltComponentSocketResponseAsSocket' STRING: '#/components/schemas/BuiltCampaignComponentVariableResponseAsString' STRING_LIST: '#/components/schemas/BuiltCampaignComponentVariableResponseAsStringList' STRING_MAP: '#/components/schemas/BuiltComponentStringMapVariableResponse' URL: '#/components/schemas/BuiltCampaignComponentVariableResponseAsUrl' WEBHOOK_ID: '#/components/schemas/BuiltCampaignComponentVariableResponseAsWebhookId' propertyName: type oneOf: - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAdminIcon' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceId' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceIdList' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsBoolean' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsBrowserSideJavascript' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsClientDomainIdList' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsClientKey' - $ref: '#/components/schemas/BuiltComponentClientKeyFlowVariableResponse' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsColor' - $ref: '#/components/schemas/BuiltComponentComponentIdVariableResponse' - $ref: '#/components/schemas/BuiltComponentComponentSettingLookupVariableResponse' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsCss' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsDelay' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsDelayList' - $ref: '#/components/schemas/BuiltComponentEnumVariableResponse' - $ref: '#/components/schemas/BuiltComponentEnumListVariableResponse' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsExtoleClientKey' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsFont' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsGlobComponentPath' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsHtml' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsImage' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsInteger' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsIntegerList' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsJson' - $ref: '#/components/schemas/BuiltComponentSocketResponseAsMultiSocket' - $ref: '#/components/schemas/BuiltComponentPartnerEnumVariableResponse' - $ref: '#/components/schemas/BuiltComponentPartnerEnumListVariableResponse' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsPersonKeyName' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsRewardSupplierId' - $ref: '#/components/schemas/BuiltComponentRewardSupplierIdListVariableResponse' - $ref: '#/components/schemas/BuiltComponentSocketResponseAsSocket' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsString' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsStringList' - $ref: '#/components/schemas/BuiltComponentStringMapVariableResponse' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsUrl' - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsWebhookId' required: - display_name - name - priority - tags - type - values BuiltCampaignComponentVariableResponseAsDelay: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - DELAY type: string type: object type: object DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignComponentVariableResponseAsPersonKeyName: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PERSON_KEY_NAME type: string type: object type: object BuiltComponentPartnerEnumVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PARTNER_ENUM type: string webhook_id: type: string options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object required: - description - display_name - name - options - priority - source - source_component_id - source_version - tags - type - values - webhook_id type: object EnabledInCampaignControllerTriggerResponseBase: description: 'The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignComponentVariableResponseAsHtml: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - HTML type: string type: object type: object HeadersInCampaignControllerActionDisplayResponse: description: 'The headers as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: string description: Literal headers title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{headers}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('headers');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignLaunchBurstRequest: properties: message: nullable: true type: string start_date: $ref: '#/components/schemas/ZonedDateTime' stop_date: $ref: '#/components/schemas/ZonedDateTime' type: object CampaignComponentVariableResponseAsUrl: allOf: - $ref: '#/components/schemas/CampaignComponentSettingResponseBase' - properties: source: enum: - INHERITED - LOCAL - PARAMETER type: string type: enum: - URL type: string 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 type: object ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse: description: 'The profile risk update interval as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal profile risk update interval properties: nano: format: int32 type: integer negative: type: boolean positive: type: boolean seconds: format: int64 type: integer units: items: properties: dateBased: type: boolean duration: $ref: '#/components/schemas/Duration' durationEstimated: type: boolean timeBased: type: boolean type: object type: array zero: type: boolean title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{profileRiskUpdateInterval}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('profileRiskUpdateInterval');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string WebhookIdInCampaignComponentPartnerEnumVariableResponse: description: 'The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal webhook id 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:{{webhookId}} 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('webhookId');} 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 securitySchemes: COOKIE: in: cookie name: extole_token type: apiKey HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey x-tagGroups: - name: Integration API - Consumer to Extole tags: - Authentication - Content - Email - Events - Persons - Profile Assets - Profiles