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 Campaign Flow Steps 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: Campaign Flow Steps paths: /v2/campaigns/{campaignId}{version}/flow-steps: get: description: Returns all flow steps for the specified campaign. operationId: listCampaignFlowSteps 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: items: $ref: '#/components/schemas/CampaignFlowStepResponse' 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 flow steps tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert post: description: Adds a new flow step to the specified campaign. Flow steps are the visual builder blocks of a participant's journey through a campaign. Returns the created flow step with its server-assigned id. operationId: createCampaignFlowStep 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: apps: - component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description name: name type: name: name component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description flow_path: flow_path icon_color: icon_color icon_type: icon_type metrics: - component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description expression: expression name: name tags: - tag unit: unit name: name sequence: 1.0 step_name: step_name tags: - tag words: person_counting_name: person_counting_name plural_noun_name: plural_noun_name rate_name: rate_name singular_noun_name: singular_noun_name verb_name: verb_name schema: $ref: '#/components/schemas/CampaignFlowStepCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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' 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: Create a campaign flow step tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/built: get: description: Returns all campaign flow steps in their fully evaluated runtime form. operationId: listBuiltCampaignFlowSteps parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: query name: flow_path schema: nullable: true type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltCampaignFlowStepResponse' 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 campaign flow steps tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}: get: description: Returns the campaign flow step for the specified id. operationId: getCampaignFlowStep parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the specified campaign flow step. Only fields present in the request body are changed. Returns the updated flow step. operationId: updateCampaignFlowStep parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string requestBody: content: application/json: example: apps: - component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description name: name type: name: name component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description flow_path: flow_path icon_color: icon_color icon_type: icon_type metrics: - component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description expression: expression name: name tags: - tag unit: unit name: name sequence: 1.0 step_name: step_name tags: - tag words: person_counting_name: person_counting_name plural_noun_name: plural_noun_name rate_name: rate_name singular_noun_name: singular_noun_name verb_name: verb_name schema: $ref: '#/components/schemas/CampaignFlowStepUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_null: $ref: '#/components/examples/invalid_null' 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' 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: Update a campaign flow step tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the specified campaign flow step and returns the deleted record. operationId: deleteCampaignFlowStep parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepResponse' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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: Delete a campaign flow step tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/built: get: description: Returns the fully evaluated (built) runtime form of the campaign flow step, with expression fields resolved. operationId: getBuiltCampaignFlowStep parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignFlowStepResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps: get: description: Returns all apps for the specified campaign flow step. operationId: listCampaignFlowStepApps parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignFlowStepAppResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step apps tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert post: description: Adds a new app to the specified campaign flow step. Returns the created app with its server-assigned id. operationId: createCampaignFlowStepApp parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description name: name type: name: name schema: $ref: '#/components/schemas/CampaignFlowStepAppCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepAppResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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' 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' 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: Create a campaign flow step app tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/built: get: description: Returns all campaign flow step apps in their fully evaluated runtime form. operationId: listBuiltCampaignFlowStepApps parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltCampaignFlowStepAppResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 campaign flow step apps tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}: get: description: Returns the campaign flow step app for the specified id. operationId: getCampaignFlowStepApp parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepAppId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepAppResponse' 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_flow_step_app_id: $ref: '#/components/examples/invalid_campaign_flow_step_app_id' invalid_campaign_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step app tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the specified campaign flow step app. Only fields present in the request body are changed. Returns the updated app. operationId: updateCampaignFlowStepApp parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepAppId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description name: name type: name: name schema: $ref: '#/components/schemas/CampaignFlowStepAppUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepAppResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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_flow_step_app_id: $ref: '#/components/examples/invalid_campaign_flow_step_app_id' invalid_campaign_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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' 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' 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: Update a campaign flow step app tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the specified campaign flow step app and returns the deleted record. operationId: deleteCampaignFlowStepApp parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepAppId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepAppResponse' 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_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_flow_step_app_id: $ref: '#/components/examples/invalid_campaign_flow_step_app_id' invalid_campaign_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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' 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' 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 flow step app tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}/built: get: description: Returns the fully evaluated (built) runtime form of the campaign flow step app, with expression fields resolved. operationId: getBuiltCampaignFlowStepApp parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepAppId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignFlowStepAppResponse' 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_flow_step_app_id: $ref: '#/components/examples/invalid_campaign_flow_step_app_id' invalid_campaign_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step app tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics: get: description: Returns all metrics for the specified campaign flow step. operationId: listCampaignFlowStepMetrics parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 flow step metrics tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert post: description: Adds a new tracking metric to the specified campaign flow step. Returns the created metric with its server-assigned id. operationId: createCampaignFlowStepMetric parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description expression: expression name: name tags: - tag unit: unit schema: $ref: '#/components/schemas/CampaignFlowStepMetricCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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' 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' 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: Create a campaign flow step metric tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/built: get: description: Returns all campaign flow step metrics in their fully evaluated runtime form. operationId: listBuiltCampaignFlowStepMetrics parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltCampaignFlowStepMetricResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_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_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 campaign flow step metrics tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}: get: description: Returns the campaign flow step metric for the specified id. operationId: getCampaignFlowStepMetric parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepMetricId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_id' invalid_campaign_flow_step_metric_id: $ref: '#/components/examples/invalid_campaign_flow_step_metric_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_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 flow step metric tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the specified campaign flow step metric. Only fields present in the request body are changed. Returns the updated metric. operationId: updateCampaignFlowStepMetric parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepMetricId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description expression: expression name: name tags: - tag unit: unit schema: $ref: '#/components/schemas/CampaignFlowStepMetricUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' 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_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_id' invalid_campaign_flow_step_metric_id: $ref: '#/components/examples/invalid_campaign_flow_step_metric_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' 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' 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: Update a campaign flow step metric tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the specified campaign flow step metric and returns the deleted record. operationId: deleteCampaignFlowStepMetric parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepMetricId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignFlowStepMetricResponse' 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_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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_id' invalid_campaign_flow_step_metric_id: $ref: '#/components/examples/invalid_campaign_flow_step_metric_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' 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' 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 flow step metric tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}/built: get: description: Returns the fully evaluated (built) runtime form of the campaign flow step metric, with expression fields resolved. operationId: getBuiltCampaignFlowStepMetric parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: flowStepId required: true schema: type: string - in: path name: flowStepMetricId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignFlowStepMetricResponse' 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_flow_step_id: $ref: '#/components/examples/invalid_campaign_flow_step_id' invalid_campaign_flow_step_metric_id: $ref: '#/components/examples/invalid_campaign_flow_step_metric_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_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 flow step metric tags: - Campaign Flow Steps x-extole-bundle: management-expert x-extole-visibility: expert 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 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_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 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 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 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 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 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 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 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 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 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 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 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 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 invalid_campaign_flow_step_app_id: summary: invalid_campaign_flow_step_app_id value: code: invalid_campaign_flow_step_app_id http_status_code: 400 message: Invalid campaign flow step app id 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_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 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 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_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 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 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 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 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 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 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_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 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 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 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_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 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 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_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 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_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 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 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 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 invalid_null: summary: invalid_null value: code: invalid_null http_status_code: 400 message: The attribute may be omitted but not nullified 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 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 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 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 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 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 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 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 invalid_campaign_flow_step_metric_id: summary: invalid_campaign_flow_step_metric_id value: code: invalid_campaign_flow_step_metric_id http_status_code: 400 message: Invalid campaign flow step metric id 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_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_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 invalid_campaign_flow_step_id: summary: invalid_campaign_flow_step_id value: code: invalid_campaign_flow_step_id http_status_code: 400 message: Invalid campaign flow step id 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 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_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 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 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_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 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 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 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_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_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 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 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_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 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_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 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_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 schemas: 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 CampaignFlowStepAppTypeCreateRequest: properties: name: $ref: '#/components/schemas/NameInCampaignFlowStepAppTypeCreateRequest' type: object 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 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 CampaignFlowStepCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps` request. properties: apps: items: $ref: '#/components/schemas/CampaignFlowStepAppCreateRequest' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepCreateRequest' flow_path: $ref: '#/components/schemas/FlowPathInCampaignFlowStepCreateRequest' icon_color: $ref: '#/components/schemas/IconColorInCampaignFlowStepCreateRequest' icon_type: $ref: '#/components/schemas/IconTypeInCampaignFlowStepCreateRequest' metrics: items: $ref: '#/components/schemas/CampaignFlowStepMetricCreateRequest' type: array name: $ref: '#/components/schemas/NameInCampaignFlowStepCreateRequest' sequence: $ref: '#/components/schemas/SequenceInCampaignFlowStepCreateRequest' step_name: $ref: '#/components/schemas/StepNameInCampaignFlowStepCreateRequest' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepCreateRequest' words: $ref: '#/components/schemas/CampaignFlowStepWordsRequest' required: - apps - flow_path - icon_color - icon_type - metrics - name - sequence - step_name - tags type: object DescriptionInCampaignFlowStepAppUpdateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true 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 UnitInCampaignFlowStepMetricUpdateRequest: description: Choose between static or dynamic unit oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 SingularNounNameInCampaignFlowStepWordsRequest: description: Choose between static or dynamic singular noun name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 DescriptionInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic description oneOf: - description: Static 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 NameInCampaignFlowStepMetricCreateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 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 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 IconTypeInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic icon type oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 TagsInCampaignFlowStepMetricUpdateRequest: description: Choose between static or dynamic tags oneOf: - description: Static 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 IconColorInCampaignFlowStepCreateRequest: description: Choose between static or dynamic icon color oneOf: - allOf: - nullable: true type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 CampaignFlowStepAppCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/apps` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepAppCreateRequest' name: $ref: '#/components/schemas/NameInCampaignFlowStepAppCreateRequest' type: $ref: '#/components/schemas/CampaignFlowStepAppTypeCreateRequest' required: - name - type 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 PersonCountingNameInCampaignFlowStepWordsRequest: description: Choose between static or dynamic person counting name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 StepNameInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic step name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 DescriptionInCampaignFlowStepMetricUpdateRequest: description: Choose between static or dynamic description oneOf: - description: Static 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 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 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 DescriptionInCampaignFlowStepCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static 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 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 CampaignFlowStepAppUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/apps/{flowStepAppId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepAppUpdateRequest' name: $ref: '#/components/schemas/NameInCampaignFlowStepAppUpdateRequest' type: $ref: '#/components/schemas/CampaignFlowStepAppTypeCreateRequest' type: object IconColorInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic icon color oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 NameInCampaignFlowStepAppTypeCreateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 IconTypeInCampaignFlowStepCreateRequest: description: Choose between static or dynamic icon type oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 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 CampaignFlowStepAppTypeResponse: properties: name: $ref: '#/components/schemas/NameInCampaignFlowStepAppTypeResponse' type: object 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 VerbNameInCampaignFlowStepWordsRequest: description: Choose between static or dynamic verb name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 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 CampaignFlowStepMetricUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepMetricUpdateRequest' expression: $ref: '#/components/schemas/ExpressionInCampaignFlowStepMetricUpdateRequest' name: $ref: '#/components/schemas/NameInCampaignFlowStepMetricUpdateRequest' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepMetricUpdateRequest' unit: $ref: '#/components/schemas/UnitInCampaignFlowStepMetricUpdateRequest' type: object ExpressionInCampaignFlowStepMetricCreateRequest: description: Choose between static or dynamic expression oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 BuiltCampaignFlowStepAppTypeResponse: properties: name: type: string type: object StepNameInCampaignFlowStepCreateRequest: description: Choose between static or dynamic step name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 DescriptionInCampaignFlowStepAppCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true 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 NameInCampaignFlowStepAppUpdateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 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 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 SequenceInCampaignFlowStepCreateRequest: description: Choose between static or dynamic sequence oneOf: - description: Static 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 FlowPathInCampaignFlowStepCreateRequest: description: Choose between static or dynamic flow path oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 NameInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 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 TagsInCampaignFlowStepCreateRequest: description: Choose between static or dynamic tags oneOf: - description: Static 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 NameInCampaignFlowStepAppCreateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object TagsInCampaignFlowStepMetricCreateRequest: description: Choose between static or dynamic tags oneOf: - description: Static 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 ExpressionInCampaignFlowStepMetricUpdateRequest: description: Choose between static or dynamic expression oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object CampaignFlowStepUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}` request. properties: apps: items: $ref: '#/components/schemas/CampaignFlowStepAppCreateRequest' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepUpdateRequest' flow_path: $ref: '#/components/schemas/FlowPathInCampaignFlowStepUpdateRequest' icon_color: $ref: '#/components/schemas/IconColorInCampaignFlowStepUpdateRequest' icon_type: $ref: '#/components/schemas/IconTypeInCampaignFlowStepUpdateRequest' metrics: items: $ref: '#/components/schemas/CampaignFlowStepMetricCreateRequest' type: array name: $ref: '#/components/schemas/NameInCampaignFlowStepUpdateRequest' sequence: $ref: '#/components/schemas/SequenceInCampaignFlowStepUpdateRequest' step_name: $ref: '#/components/schemas/StepNameInCampaignFlowStepUpdateRequest' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepUpdateRequest' words: $ref: '#/components/schemas/CampaignFlowStepWordsRequest' type: object CampaignFlowStepMetricCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/metrics` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInCampaignFlowStepMetricCreateRequest' expression: $ref: '#/components/schemas/ExpressionInCampaignFlowStepMetricCreateRequest' name: $ref: '#/components/schemas/NameInCampaignFlowStepMetricCreateRequest' tags: $ref: '#/components/schemas/TagsInCampaignFlowStepMetricCreateRequest' unit: $ref: '#/components/schemas/UnitInCampaignFlowStepMetricCreateRequest' required: - description - expression - name - tags - unit type: object CampaignFlowStepWordsRequest: properties: person_counting_name: $ref: '#/components/schemas/PersonCountingNameInCampaignFlowStepWordsRequest' plural_noun_name: $ref: '#/components/schemas/PluralNounNameInCampaignFlowStepWordsRequest' rate_name: $ref: '#/components/schemas/RateNameInCampaignFlowStepWordsRequest' singular_noun_name: $ref: '#/components/schemas/SingularNounNameInCampaignFlowStepWordsRequest' verb_name: $ref: '#/components/schemas/VerbNameInCampaignFlowStepWordsRequest' type: object FlowPathInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic flow path oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 DescriptionInCampaignFlowStepMetricCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description 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 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 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 SequenceInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic sequence oneOf: - description: Static 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 PluralNounNameInCampaignFlowStepWordsRequest: description: Choose between static or dynamic plural noun name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 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 RateNameInCampaignFlowStepWordsRequest: description: Choose between static or dynamic rate name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 NameInCampaignFlowStepCreateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 NameInCampaignFlowStepMetricUpdateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 UnitInCampaignFlowStepMetricCreateRequest: description: Choose between static or dynamic unit oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static 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 TagsInCampaignFlowStepUpdateRequest: description: Choose between static or dynamic tags oneOf: - description: Static 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 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 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