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 Controllers Actions 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 Controllers Actions paths: /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions: get: description: Returns all actions configured on the specified campaign controller, across all action types. operationId: listCampaignControllerActions parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignControllerActionResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 all campaign controller actions tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves/{actionId}: get: description: Returns the approve action configuration for the specified action id on the given campaign controller. operationId: getApproveAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionApproveResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an approve action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the approve action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateApproveAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: cause_type: cause_type component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_type: event_type force: force legacy_action_id: legacy_action_id note: note partner_event_id: partner_event_id polling_id: polling_id polling_name: polling_name quality: ALWAYS reward_tags: - reward_tag schema: $ref: '#/components/schemas/CampaignControllerActionApproveUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionApproveResponse' 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_controller_action_approve_cause_type_length: $ref: '#/components/examples/campaign_controller_action_approve_cause_type_length' campaign_controller_action_approve_event_type_length: $ref: '#/components/examples/campaign_controller_action_approve_event_type_length' campaign_controller_action_approve_force_length: $ref: '#/components/examples/campaign_controller_action_approve_force_length' campaign_controller_action_approve_legacy_action_id_length: $ref: '#/components/examples/campaign_controller_action_approve_legacy_action_id_length' campaign_controller_action_approve_note_length: $ref: '#/components/examples/campaign_controller_action_approve_note_length' campaign_controller_action_approve_partner_event_id_length: $ref: '#/components/examples/campaign_controller_action_approve_partner_event_id_length' campaign_controller_action_approve_polling_id_length: $ref: '#/components/examples/campaign_controller_action_approve_polling_id_length' campaign_controller_action_approve_polling_name_length: $ref: '#/components/examples/campaign_controller_action_approve_polling_name_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an approve action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the approve action from the specified campaign controller. Returns the deleted action record. operationId: deleteApproveAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionApproveResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an approve action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards/{actionId}: get: description: Returns the cancel-reward action configuration for the specified action id on the given campaign controller. operationId: getCancelRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 cancel-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the cancel-reward action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateCancelRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true message: message quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' 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_controller_action_cancel_reward_empty_reward_id: $ref: '#/components/examples/campaign_controller_action_cancel_reward_empty_reward_id' campaign_controller_action_cancel_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_invalid_expression' campaign_controller_action_cancel_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_too_long_expression' campaign_controller_action_cancel_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 cancel-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the cancel-reward action from the specified campaign controller. Returns the deleted action record. operationId: deleteCancelRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 cancel-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships/{actionId}: get: description: Returns the create-membership action configuration for the specified action id on the given campaign controller. operationId: getCreateMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 create-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the create-membership action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateCreateMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: audience_id: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' 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_controller_action_create_membership_audience_not_found: $ref: '#/components/examples/campaign_controller_action_create_membership_audience_not_found' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 create-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the create-membership action from the specified campaign controller. Returns the deleted action record. operationId: deleteCreateMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 create-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}: get: description: Returns the creative action configuration for the specified action id on the given campaign controller. operationId: getCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 creative action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert post: description: Uploads a creative archive zip to the specified creative action on the given campaign controller. Returns the updated creative action. operationId: uploadCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: multipart/form-data: example: attributes: fileName: fileName size: 1 inputStream: {} schema: $ref: '#/components/schemas/FileInputStreamRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' 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' creative_archive_size_too_big: $ref: '#/components/examples/creative_archive_size_too_big' creative_asset_file_path_invalid: $ref: '#/components/examples/creative_asset_file_path_invalid' creative_asset_file_path_too_long: $ref: '#/components/examples/creative_asset_file_path_too_long' creative_asset_file_size_too_big: $ref: '#/components/examples/creative_asset_file_size_too_big' creative_asset_invalid_character_encoding: $ref: '#/components/examples/creative_asset_invalid_character_encoding' creative_has_default_locale_disabled: $ref: '#/components/examples/creative_has_default_locale_disabled' creative_has_incompatible_api_version: $ref: '#/components/examples/creative_has_incompatible_api_version' creative_has_invalid_api_version: $ref: '#/components/examples/creative_has_invalid_api_version' creative_has_invalid_locale: $ref: '#/components/examples/creative_has_invalid_locale' creative_has_unknown_classification: $ref: '#/components/examples/creative_has_unknown_classification' creative_is_missing_attributes: $ref: '#/components/examples/creative_is_missing_attributes' creative_is_missing_renderer: $ref: '#/components/examples/creative_is_missing_renderer' creative_mismatch_api_version: $ref: '#/components/examples/creative_mismatch_api_version' date_invalid: $ref: '#/components/examples/date_invalid' download_error: $ref: '#/components/examples/download_error' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' invalid_archive_id: $ref: '#/components/examples/invalid_archive_id' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' javascript_error: $ref: '#/components/examples/javascript_error' 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' upload_error: $ref: '#/components/examples/upload_error' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' campaign_controller_action_creative_archive_error: $ref: '#/components/examples/campaign_controller_action_creative_archive_error' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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: Upload a creative action archive tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the creative action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: api_version: 1 classification: EMAIL component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS theme_version: theme_version schema: $ref: '#/components/schemas/CampaignControllerActionCreativeUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' 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_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_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' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reserved_name: $ref: '#/components/examples/reserved_name' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 creative action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the creative action from the specified campaign controller. Returns the deleted action record. operationId: deleteCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 creative action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}.zip: get: description: Downloads the creative archive zip for the specified creative action on the given campaign controller. operationId: downloadCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string - in: query name: filename schema: type: string responses: '200': content: application/zip: schema: format: binary type: string description: Creative action archive as a ZIP file. '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_controller_action_creative_missing_archive: $ref: '#/components/examples/campaign_controller_action_creative_missing_archive' 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' creative_archive_size_too_big: $ref: '#/components/examples/creative_archive_size_too_big' creative_asset_file_path_invalid: $ref: '#/components/examples/creative_asset_file_path_invalid' creative_asset_file_path_too_long: $ref: '#/components/examples/creative_asset_file_path_too_long' creative_asset_file_size_too_big: $ref: '#/components/examples/creative_asset_file_size_too_big' creative_asset_invalid_character_encoding: $ref: '#/components/examples/creative_asset_invalid_character_encoding' creative_has_default_locale_disabled: $ref: '#/components/examples/creative_has_default_locale_disabled' creative_has_incompatible_api_version: $ref: '#/components/examples/creative_has_incompatible_api_version' creative_has_invalid_api_version: $ref: '#/components/examples/creative_has_invalid_api_version' creative_has_invalid_locale: $ref: '#/components/examples/creative_has_invalid_locale' creative_has_unknown_classification: $ref: '#/components/examples/creative_has_unknown_classification' creative_is_missing_attributes: $ref: '#/components/examples/creative_is_missing_attributes' creative_is_missing_renderer: $ref: '#/components/examples/creative_is_missing_renderer' creative_mismatch_api_version: $ref: '#/components/examples/creative_mismatch_api_version' date_invalid: $ref: '#/components/examples/date_invalid' download_error: $ref: '#/components/examples/download_error' invalid_archive_id: $ref: '#/components/examples/invalid_archive_id' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' javascript_error: $ref: '#/components/examples/javascript_error' 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' upload_error: $ref: '#/components/examples/upload_error' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Download a creative action archive tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences: get: description: Returns all data-intelligence actions configured on the specified campaign controller. operationId: listDataIntelligenceActions parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 data-intelligence actions tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert post: description: Adds a data-intelligence action to the specified campaign controller. When the controller's triggers fire, this action sends the participant's event data to the Data Intelligence pipeline for ML scoring. Returns the created data-intelligence action with its server-assigned id. operationId: createDataIntelligenceAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_name: event_name intelligence_provider: EMAIL_AGE profile_risk_update_interval: nano: 1 negative: true positive: true seconds: 1 units: - dateBased: true duration: PT42S durationEstimated: true timeBased: true zero: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' 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_controller_action_data_intelligence_event_invalid_event_name: $ref: '#/components/examples/campaign_controller_action_data_intelligence_event_invalid_event_name' campaign_controller_action_data_intelligence_event_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_data_intelligence_event_name_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 data-intelligence action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences/{actionId}: get: description: Returns the data-intelligence action configuration for the specified action id on the given campaign controller. operationId: getDataIntelligenceAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 data-intelligence action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the data-intelligence action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateDataIntelligenceAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_name: event_name intelligence_provider: EMAIL_AGE profile_risk_update_interval: nano: 1 negative: true positive: true seconds: 1 units: - dateBased: true duration: PT42S durationEstimated: true timeBased: true zero: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' 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_controller_action_data_intelligence_event_invalid_event_name: $ref: '#/components/examples/campaign_controller_action_data_intelligence_event_invalid_event_name' campaign_controller_action_data_intelligence_event_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_data_intelligence_event_name_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 data-intelligence action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the data-intelligence action from the specified campaign controller. Returns the deleted action record. operationId: deleteDataIntelligenceAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 data-intelligence action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines/{actionId}: get: description: Returns the decline action configuration for the specified action id on the given campaign controller. operationId: getDeclineAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 decline action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the decline action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateDeclineAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: cause_type: cause_type component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_type: event_type legacy_action_id: legacy_action_id note: note partner_event_id: partner_event_id polling_id: polling_id polling_name: polling_name quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionDeclineUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' 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_controller_action_decline_cause_type_length: $ref: '#/components/examples/campaign_controller_action_decline_cause_type_length' campaign_controller_action_decline_event_type_length: $ref: '#/components/examples/campaign_controller_action_decline_event_type_length' campaign_controller_action_decline_legacy_action_id_length: $ref: '#/components/examples/campaign_controller_action_decline_legacy_action_id_length' campaign_controller_action_decline_note_length: $ref: '#/components/examples/campaign_controller_action_decline_note_length' campaign_controller_action_decline_partner_event_id_length: $ref: '#/components/examples/campaign_controller_action_decline_partner_event_id_length' campaign_controller_action_decline_polling_id_length: $ref: '#/components/examples/campaign_controller_action_decline_polling_id_length' campaign_controller_action_decline_polling_name_length: $ref: '#/components/examples/campaign_controller_action_decline_polling_name_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 decline action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the decline action from the specified campaign controller. Returns the deleted action record. operationId: deleteDeclineAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 decline action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards/{actionId}: get: description: Returns the earn-reward action configuration for the specified action id on the given campaign controller. operationId: getEarnRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an earn-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the earn-reward action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateEarnRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_time: '2025-10-24T09:00:00.000Z' extra_data: extra_data_key: {} polling_id: polling_id program_domain_id: program_domain_id quality: ALWAYS reward_action_id: reward_action_id reward_name: reward_name reward_supplier_id: {} sandbox: sandbox slots: - slot tags: - tag value_of_event_being_rewarded: {} schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' 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_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an earn-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the earn-reward action from the specified campaign controller. Returns the deleted action record. operationId: deleteEarnRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an earn-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions/{actionId}: get: description: Returns the expression action configuration for the specified action id on the given campaign controller. operationId: getExpressionAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an expression action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the expression action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateExpressionAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true expression: {} quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionExpressionUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' expression_length_invalid: $ref: '#/components/examples/expression_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an expression action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the expression action from the specified campaign controller. Returns the deleted action record. operationId: deleteExpressionAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an expression action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards/{actionId}: get: description: Returns the fulfill-reward action configuration for the specified action id on the given campaign controller. operationId: getFulfillRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fulfill-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the fulfill-reward action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateFulfillRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: amount: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_time: '2025-10-24T09:00:00.000Z' message: message partner_reward_id: partner_reward_id quality: ALWAYS reward_id: reward_id success: success schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' 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_controller_action_fulfill_reward_empty_reward_id: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_empty_reward_id' campaign_controller_action_fulfill_reward_invalid_spel_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_invalid_spel_expression' campaign_controller_action_fulfill_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_too_long_expression' campaign_controller_action_fulfill_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fulfill-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the fulfill-reward action from the specified campaign controller. Returns the deleted action record. operationId: deleteFulfillRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fulfill-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards/{actionId}: get: description: Returns the redeem-reward action configuration for the specified action id on the given campaign controller. operationId: getRedeemRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 redeem-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the redeem-reward action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateRedeemRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: data_key enabled: true event_time: '2025-10-24T09:00:00.000Z' partner_event_id: partner_event_id quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' 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_controller_action_redeem_reward_data_attribute_name_invalid: $ref: '#/components/examples/campaign_controller_action_redeem_reward_data_attribute_name_invalid' campaign_controller_action_redeem_reward_data_attribute_value_invalid: $ref: '#/components/examples/campaign_controller_action_redeem_reward_data_attribute_value_invalid' campaign_controller_action_redeem_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_invalid_expression' campaign_controller_action_redeem_reward_missing_reward_id: $ref: '#/components/examples/campaign_controller_action_redeem_reward_missing_reward_id' campaign_controller_action_redeem_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_too_long_expression' campaign_controller_action_redeem_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 redeem-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the redeem-reward action from the specified campaign controller. Returns the deleted action record. operationId: deleteRedeemRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 redeem-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships/{actionId}: get: description: Returns the remove-membership action configuration for the specified action id on the given campaign controller. operationId: getRemoveMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 remove-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the remove-membership action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateRemoveMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: audience_id: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' 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_controller_action_remove_membership_audience_not_found: $ref: '#/components/examples/campaign_controller_action_remove_membership_audience_not_found' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 remove-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the remove-membership action from the specified campaign controller. Returns the deleted action record. operationId: deleteRemoveMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 remove-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards/{actionId}: get: description: Returns the revoke-reward action configuration for the specified action id on the given campaign controller. operationId: getRevokeRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 revoke-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the revoke-reward action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateRevokeRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true message: message quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' 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_controller_action_revoke_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_invalid_expression' campaign_controller_action_revoke_reward_missing_reward_id: $ref: '#/components/examples/campaign_controller_action_revoke_reward_missing_reward_id' campaign_controller_action_revoke_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_too_long_expression' campaign_controller_action_revoke_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 revoke-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the revoke-reward action from the specified campaign controller. Returns the deleted action record. operationId: deleteRevokeRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 revoke-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules/{actionId}: get: description: Returns the schedule action configuration for the specified action id on the given campaign controller. operationId: getScheduleAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 schedule action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the schedule action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateScheduleAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} dates: - '2025-10-24T02:00:00-07:00' delays: - PT42S enabled: true extra_data: extra_data_key: {} force: true quality: ALWAYS schedule_name: schedule_name schema: $ref: '#/components/schemas/CampaignControllerActionScheduleUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' 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_controller_action_schedule_backdated_date_not_allowed: $ref: '#/components/examples/campaign_controller_action_schedule_backdated_date_not_allowed' campaign_controller_action_schedule_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_schedule_data_entry_name_out_of_range' campaign_controller_action_schedule_delays_and_dates_not_supported_together: $ref: '#/components/examples/campaign_controller_action_schedule_delays_and_dates_not_supported_together' campaign_controller_action_schedule_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_schedule_duplicate_data_entry_name' campaign_controller_action_schedule_invalid_date: $ref: '#/components/examples/campaign_controller_action_schedule_invalid_date' campaign_controller_action_schedule_invalid_delay: $ref: '#/components/examples/campaign_controller_action_schedule_invalid_delay' campaign_controller_action_schedule_missing_schedule_name: $ref: '#/components/examples/campaign_controller_action_schedule_missing_schedule_name' campaign_controller_action_schedule_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_schedule_name_contains_illegal_character' campaign_controller_action_schedule_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_schedule_name_out_of_range' campaign_controller_action_schedule_negative_delay: $ref: '#/components/examples/campaign_controller_action_schedule_negative_delay' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 schedule action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the schedule action from the specified campaign controller. Returns the deleted action record. operationId: deleteScheduleAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 schedule action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events/{actionId}: get: description: Returns the share-event action configuration for the specified action id on the given campaign controller. operationId: getShareEventAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 share-event action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the share-event action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateShareEventAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionShareEventRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 share-event action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the share-event action from the specified campaign controller. Returns the deleted action record. operationId: deleteShareEventAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 share-event action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1/{actionId}: get: description: Returns the signal-v1 action configuration for the specified action id on the given campaign controller. operationId: getSignalV1Action parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal-v1 action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the signal-v1 action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateSignalV1Action parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: data_key enabled: true quality: ALWAYS signal_polling_id: signal_polling_id schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1UpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' 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_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' campaign_controller_action_signal_data_attribute_name_invalid: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_name_invalid' campaign_controller_action_signal_data_attribute_name_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_name_length_out_of_range' campaign_controller_action_signal_data_attribute_value_invalid: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_value_invalid' campaign_controller_action_signal_data_attribute_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_value_length_out_of_range' campaign_controller_action_signal_signal_polling_id_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_signal_polling_id_out_of_range' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal-v1 action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the signal-v1 action from the specified campaign controller. Returns the deleted action record. operationId: deleteSignalV1Action parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal-v1 action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals/{actionId}: get: description: Returns the signal action configuration for the specified action id on the given campaign controller. operationId: getSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the signal action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true name: name quality: ALWAYS signal_polling_id: signal_polling_id schema: $ref: '#/components/schemas/CampaignControllerActionSignalUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' name_length_invalid: $ref: '#/components/examples/name_length_invalid' 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' signal_polling_id_length_invalid: $ref: '#/components/examples/signal_polling_id_length_invalid' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the signal action from the specified campaign controller. Returns the deleted action record. operationId: deleteSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals/{actionId}: get: description: Returns the step-signal action configuration for the specified action id on the given campaign controller. operationId: getStepSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 step-signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the step-signal action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateStepSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true name: name polling_id: polling_id quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' 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_controller_action_step_signal_name_invalid_length: $ref: '#/components/examples/campaign_controller_action_step_signal_name_invalid_length' campaign_controller_action_step_signal_polling_id_invalid_expression: $ref: '#/components/examples/campaign_controller_action_step_signal_polling_id_invalid_expression' campaign_controller_action_step_signal_polling_id_invalid_length: $ref: '#/components/examples/campaign_controller_action_step_signal_polling_id_invalid_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 step-signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the step-signal action from the specified campaign controller. Returns the deleted action record. operationId: deleteStepSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 step-signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks/{actionId}: get: description: Returns the webhook action configuration for the specified action id on the given campaign controller. operationId: getWebhookAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 webhook action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the webhook action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateWebhookAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true quality: ALWAYS webhook_id: {} schema: $ref: '#/components/schemas/CampaignControllerActionWebhookUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' webhook_missing: $ref: '#/components/examples/webhook_missing' webhook_not_found: $ref: '#/components/examples/webhook_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 webhook action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the webhook action from the specified campaign controller. Returns the deleted action record. operationId: deleteWebhookAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 webhook action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/{actionId}: get: description: Returns the action configuration for the specified action id, regardless of type. operationId: getCampaignControllerAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 controller action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}: get: description: Returns the display action configuration for the specified action id on the given campaign controller. operationId: getDisplayAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 display action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the display action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateDisplayAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: body: body component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true headers: headers_key: headers_key quality: ALWAYS response: body: body headers: headers_key: headers_key statusCode: 1 schema: $ref: '#/components/schemas/CampaignControllerActionDisplayUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 display action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the display action from the specified campaign controller. Returns the deleted action record. operationId: deleteDisplayAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 display action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}/built: get: description: Returns the fully evaluated (built) runtime form of the display action, with all expression fields resolved. operationId: getBuiltDisplayAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignControllerActionDisplayResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 the built display action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}: get: description: Returns the email action configuration for the specified action id on the given campaign controller. operationId: getEmailAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEmailResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an email action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the email action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateEmailAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true quality: ALWAYS zone_name: zone_name schema: $ref: '#/components/schemas/CampaignControllerActionEmailUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEmailResponse' 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_controller_action_email_missing_zone_name: $ref: '#/components/examples/campaign_controller_action_email_missing_zone_name' campaign_controller_action_email_zone_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_email_zone_name_contains_illegal_character' campaign_controller_action_email_zone_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_email_zone_name_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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an email action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the email action from the specified campaign controller. Returns the deleted action record. operationId: deleteEmailAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEmailResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an email action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}/built: get: description: Returns the fully evaluated (built) runtime form of the email action, with all expression fields resolved. operationId: getBuiltEmailAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignControllerActionEmailResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 the built email action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}: get: description: Returns the fire-as-person action configuration for the specified action id on the given campaign controller. operationId: getFireAsPersonAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fire-as-person action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the fire-as-person action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateFireAsPersonAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: as_person_identification: person_identification_type: EMAIL value: value as_person_journey: advocate_code: advocate_code advocate_partner_user_id: advocate_partner_user_id campaign_id: campaign_id container: container coupon_code: coupon_code journey_type: journey_type label: label promotable_code: promotable_code reason: reason referral_reason: ADVOCATE share_id: share_id shareable_id: shareable_id zone: zone component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_name: event_name event_time: '2025-10-24T02:00:00-07:00' extra_data: extra_data_key: {} labels: - label person_id: {} quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' 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_controller_action_fire_as_person_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_data_entry_name_out_of_range' campaign_controller_action_fire_as_person_double_person_identification: $ref: '#/components/examples/campaign_controller_action_fire_as_person_double_person_identification' campaign_controller_action_fire_as_person_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_fire_as_person_duplicate_data_entry_name' campaign_controller_action_fire_as_person_event_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_fire_as_person_event_name_contains_illegal_character' campaign_controller_action_fire_as_person_event_name_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_event_name_length_out_of_range' campaign_controller_action_fire_as_person_identification_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_missing' campaign_controller_action_fire_as_person_identification_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_value_length_out_of_range' campaign_controller_action_fire_as_person_identification_value_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_value_missing' campaign_controller_action_fire_as_person_journey_field_invalid: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_field_invalid' campaign_controller_action_fire_as_person_journey_field_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_field_out_of_range' campaign_controller_action_fire_as_person_journey_missing_referral_data: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_missing_referral_data' campaign_controller_action_fire_as_person_journey_name_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_name_missing' campaign_controller_action_fire_as_person_label_illegal_characters: $ref: '#/components/examples/campaign_controller_action_fire_as_person_label_illegal_characters' campaign_controller_action_fire_as_person_label_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_label_out_of_range' campaign_controller_action_fire_as_person_missing_event_name: $ref: '#/components/examples/campaign_controller_action_fire_as_person_missing_event_name' campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range' campaign_controller_action_fire_as_person_partner_event_key_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_partner_event_key_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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fire-as-person action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the fire-as-person action from the specified campaign controller. Returns the deleted action record. operationId: deleteFireAsPersonAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fire-as-person action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built: get: description: Returns the fully evaluated (built) runtime form of the fire-as-person action, with all expression fields resolved. operationId: getBuiltFireAsPersonAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignControllerActionFireAsPersonResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 the built fire-as-person action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}: get: description: Returns the incentivize-status-update action configuration for the specified action id on the given campaign controller. operationId: getIncentivizeStatusUpdateAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize-status-update action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the incentivize-status-update action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateIncentivizeStatusUpdateAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_type: CLICK legacy_action_id: legacy_action_id message: message move_to_pending: true partner_event_id: partner_event_id quality: ALWAYS review_status: review_status schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize-status-update action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the incentivize-status-update action from the specified campaign controller. Returns the deleted action record. operationId: deleteIncentivizeStatusUpdateAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize-status-update action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}/built: get: description: Returns the fully evaluated (built) runtime form of the incentivize-status-update action, with all expression fields resolved. operationId: getBuiltIncentivizeStatusUpdateAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignControllerActionIncentivizeStatusUpdateResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 the built incentivize-status-update action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}: get: description: Returns the incentivize action configuration for the specified action id on the given campaign controller. operationId: getIncentivizeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert put: description: Updates the incentivize action on the specified campaign controller. Only fields present in the request body are changed. Returns the updated action. operationId: updateIncentivizeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string requestBody: content: application/json: example: action_name: action_name component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true incentivize_action_type: CLICK overrides: overrides_key: overrides_key quality: ALWAYS review_status: EVALUATING schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' 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_controller_action_incentivize_action_name_invalid_expression: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_expression' campaign_controller_action_incentivize_action_name_invalid_length: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_length' campaign_controller_action_incentivize_action_name_invalid_value: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_value' campaign_controller_action_incentivize_action_type_missing: $ref: '#/components/examples/campaign_controller_action_incentivize_action_type_missing' campaign_controller_action_incentivize_override_value_invalid: $ref: '#/components/examples/campaign_controller_action_incentivize_override_value_invalid' campaign_controller_action_incentivize_override_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_incentivize_override_value_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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert delete: description: Removes the incentivize action from the specified campaign controller. Returns the deleted action record. operationId: deleteIncentivizeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}/built: get: description: Returns the fully evaluated (built) runtime form of the incentivize action, with all expression fields resolved. operationId: getBuiltIncentivizeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string - in: path name: actionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignControllerActionIncentivizeResponse' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 the built incentivize action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves: post: description: Adds an approve action to the specified campaign controller. When the controller's triggers fire, this action approves the participant's pending step or reward in the journey. Returns the created approve action with its server-assigned id. operationId: createApproveAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: cause_type: cause_type component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_type: event_type force: force legacy_action_id: legacy_action_id note: note partner_event_id: partner_event_id polling_id: polling_id polling_name: polling_name quality: ALWAYS reward_tags: - reward_tag schema: $ref: '#/components/schemas/CampaignControllerActionApproveCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionApproveResponse' 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_controller_action_approve_cause_type_length: $ref: '#/components/examples/campaign_controller_action_approve_cause_type_length' campaign_controller_action_approve_event_type_length: $ref: '#/components/examples/campaign_controller_action_approve_event_type_length' campaign_controller_action_approve_force_length: $ref: '#/components/examples/campaign_controller_action_approve_force_length' campaign_controller_action_approve_legacy_action_id_length: $ref: '#/components/examples/campaign_controller_action_approve_legacy_action_id_length' campaign_controller_action_approve_note_length: $ref: '#/components/examples/campaign_controller_action_approve_note_length' campaign_controller_action_approve_partner_event_id_length: $ref: '#/components/examples/campaign_controller_action_approve_partner_event_id_length' campaign_controller_action_approve_polling_id_length: $ref: '#/components/examples/campaign_controller_action_approve_polling_id_length' campaign_controller_action_approve_polling_name_length: $ref: '#/components/examples/campaign_controller_action_approve_polling_name_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an approve action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards: post: description: Adds a cancel-reward action to the specified campaign controller. When the controller's triggers fire, this action cancels the specified reward for the participant. Returns the created cancel-reward action with its server-assigned id. operationId: createCancelRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true message: message quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' 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_controller_action_cancel_reward_empty_reward_id: $ref: '#/components/examples/campaign_controller_action_cancel_reward_empty_reward_id' campaign_controller_action_cancel_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_invalid_expression' campaign_controller_action_cancel_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_too_long_expression' campaign_controller_action_cancel_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_cancel_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 cancel-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships: post: description: Adds a create-membership action to the specified campaign controller. When the controller's triggers fire, this action adds the participant to the specified audience. Returns the created create-membership action with its server-assigned id. operationId: createCreateMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: audience_id: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' 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_controller_action_create_membership_audience_not_found: $ref: '#/components/examples/campaign_controller_action_create_membership_audience_not_found' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 create-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives: post: description: Adds a creative action to the specified campaign controller. When the controller's triggers fire, this action renders the configured creative asset for the participant. Returns the created creative action with its server-assigned id. operationId: createCreativeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: controllerId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string requestBody: content: application/json: example: api_version: 1 classification: EMAIL component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS theme_version: theme_version schema: $ref: '#/components/schemas/CampaignControllerActionCreativeCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' 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_frontend_controller_duplicate_controller: $ref: '#/components/examples/campaign_frontend_controller_duplicate_controller' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' controller_misconfiguration: $ref: '#/components/examples/controller_misconfiguration' controller_name_length_out_of_range: $ref: '#/components/examples/controller_name_length_out_of_range' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_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' name_contains_illegal_character: $ref: '#/components/examples/name_contains_illegal_character' not_found_page_forbidden_runtime_expressions: $ref: '#/components/examples/not_found_page_forbidden_runtime_expressions' not_found_page_invalid_action: $ref: '#/components/examples/not_found_page_invalid_action' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reserved_name: $ref: '#/components/examples/reserved_name' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 creative action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines: post: description: Adds a decline action to the specified campaign controller. When the controller's triggers fire, this action declines the participant's pending step or reward in the journey. Returns the created decline action with its server-assigned id. operationId: createDeclineAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: cause_type: cause_type component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_type: event_type legacy_action_id: legacy_action_id note: note partner_event_id: partner_event_id polling_id: polling_id polling_name: polling_name quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionDeclineCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' 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_controller_action_decline_cause_type_length: $ref: '#/components/examples/campaign_controller_action_decline_cause_type_length' campaign_controller_action_decline_event_type_length: $ref: '#/components/examples/campaign_controller_action_decline_event_type_length' campaign_controller_action_decline_legacy_action_id_length: $ref: '#/components/examples/campaign_controller_action_decline_legacy_action_id_length' campaign_controller_action_decline_note_length: $ref: '#/components/examples/campaign_controller_action_decline_note_length' campaign_controller_action_decline_partner_event_id_length: $ref: '#/components/examples/campaign_controller_action_decline_partner_event_id_length' campaign_controller_action_decline_polling_id_length: $ref: '#/components/examples/campaign_controller_action_decline_polling_id_length' campaign_controller_action_decline_polling_name_length: $ref: '#/components/examples/campaign_controller_action_decline_polling_name_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 decline action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays: post: description: Adds a display action to the specified campaign controller. When the controller's triggers fire, this action controls which content zone or creative is displayed to the participant. Returns the created display action with its server-assigned id. operationId: createDisplayAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: body: body component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true headers: headers_key: headers_key quality: ALWAYS response: body: body headers: headers_key: headers_key statusCode: 1 schema: $ref: '#/components/schemas/CampaignControllerActionDisplayCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 display action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards: post: description: Adds an earn-reward action to the specified campaign controller. When the controller's triggers fire, this action earns (issues) a new reward for the participant through the configured reward supplier. Returns the created earn-reward action with its server-assigned id. operationId: createEarnRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_time: '2025-10-24T09:00:00.000Z' extra_data: extra_data_key: {} quality: ALWAYS reward_action_id: reward_action_id reward_name: reward_name reward_supplier_id: {} slots: - slot tags: - tag value_of_event_being_rewarded: {} schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' 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_controller_action_earn_reward_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_earn_reward_data_entry_name_out_of_range' campaign_controller_action_earn_reward_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_duplicate_data_entry_name' campaign_controller_action_earn_reward_invalid_tag: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tag' campaign_controller_action_earn_reward_invalid_tags_length: $ref: '#/components/examples/campaign_controller_action_earn_reward_invalid_tags_length' campaign_controller_action_earn_reward_missing_reward_name: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_name' campaign_controller_action_earn_reward_missing_reward_supplier: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_reward_supplier' campaign_controller_action_earn_reward_missing_tags: $ref: '#/components/examples/campaign_controller_action_earn_reward_missing_tags' campaign_controller_action_earn_reward_reward_name_too_long: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_name_too_long' campaign_controller_action_earn_reward_reward_supplier_id_not_found: $ref: '#/components/examples/campaign_controller_action_earn_reward_reward_supplier_id_not_found' campaign_controller_action_earn_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_too_long_expression' campaign_controller_action_earn_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_earn_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an earn-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails: post: description: Adds an email action to the specified campaign controller. When the controller's triggers fire, this action sends the configured email to the participant. Returns the created email action with its server-assigned id. operationId: createEmailAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true quality: ALWAYS zone_name: zone_name schema: $ref: '#/components/schemas/CampaignControllerActionEmailCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionEmailResponse' 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_controller_action_email_missing_zone_name: $ref: '#/components/examples/campaign_controller_action_email_missing_zone_name' campaign_controller_action_email_zone_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_email_zone_name_contains_illegal_character' campaign_controller_action_email_zone_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_email_zone_name_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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an email action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions: post: description: Adds an expression action to the specified campaign controller. When the controller's triggers fire, this action evaluates the configured JavaScript expression in the campaign runtime context. Returns the created expression action with its server-assigned id. operationId: createExpressionAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true expression: {} quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionExpressionCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' expression_length_invalid: $ref: '#/components/examples/expression_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an expression action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person: post: description: Adds a fire-as-person action to the specified campaign controller. When the controller's triggers fire, this action fires the configured campaign step as a different person identity. Returns the created fire-as-person action with its server-assigned id. operationId: createFireAsPersonAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: as_person_identification: person_identification_type: EMAIL value: value as_person_journey: advocate_code: advocate_code advocate_partner_user_id: advocate_partner_user_id campaign_id: campaign_id container: container coupon_code: coupon_code journey_type: journey_type label: label promotable_code: promotable_code reason: reason referral_reason: ADVOCATE share_id: share_id shareable_id: shareable_id zone: zone component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_name: event_name event_time: '2025-10-24T02:00:00-07:00' extra_data: extra_data_key: {} labels: - label person_id: {} quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' 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_controller_action_fire_as_person_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_data_entry_name_out_of_range' campaign_controller_action_fire_as_person_double_person_identification: $ref: '#/components/examples/campaign_controller_action_fire_as_person_double_person_identification' campaign_controller_action_fire_as_person_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_fire_as_person_duplicate_data_entry_name' campaign_controller_action_fire_as_person_event_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_fire_as_person_event_name_contains_illegal_character' campaign_controller_action_fire_as_person_event_name_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_event_name_length_out_of_range' campaign_controller_action_fire_as_person_identification_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_missing' campaign_controller_action_fire_as_person_identification_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_value_length_out_of_range' campaign_controller_action_fire_as_person_identification_value_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_identification_value_missing' campaign_controller_action_fire_as_person_journey_field_invalid: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_field_invalid' campaign_controller_action_fire_as_person_journey_field_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_field_out_of_range' campaign_controller_action_fire_as_person_journey_missing_referral_data: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_missing_referral_data' campaign_controller_action_fire_as_person_journey_name_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_journey_name_missing' campaign_controller_action_fire_as_person_label_illegal_characters: $ref: '#/components/examples/campaign_controller_action_fire_as_person_label_illegal_characters' campaign_controller_action_fire_as_person_label_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_label_out_of_range' campaign_controller_action_fire_as_person_missing_event_name: $ref: '#/components/examples/campaign_controller_action_fire_as_person_missing_event_name' campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range' campaign_controller_action_fire_as_person_partner_event_key_missing: $ref: '#/components/examples/campaign_controller_action_fire_as_person_partner_event_key_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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fire-as-person action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards: post: description: Adds a fulfill-reward action to the specified campaign controller. When the controller's triggers fire, this action fulfills a previously earned reward, triggering downstream fulfilment logic. Returns the created fulfill-reward action with its server-assigned id. operationId: createFulfillRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: amount: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true event_time: '2025-10-24T09:00:00.000Z' message: message partner_reward_id: partner_reward_id quality: ALWAYS reward_id: reward_id success: success schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' 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_controller_action_fulfill_reward_empty_reward_id: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_empty_reward_id' campaign_controller_action_fulfill_reward_invalid_spel_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_invalid_spel_expression' campaign_controller_action_fulfill_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_too_long_expression' campaign_controller_action_fulfill_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_fulfill_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 fulfill-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates: post: description: Adds an incentivize-status-update action to the specified campaign controller. When the controller's triggers fire, this action updates the status of a pending incentivize action. Returns the created incentivize-status-update action with its server-assigned id. operationId: createIncentivizeStatusUpdateAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true event_type: CLICK legacy_action_id: legacy_action_id message: message move_to_pending: true partner_event_id: partner_event_id quality: ALWAYS review_status: review_status schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize-status-update action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes: post: description: Adds an incentivize action to the specified campaign controller. When the controller's triggers fire, this action issues an incentive (coupon, gift card, payout, etc.) to the participant. Returns the created incentivize action with its server-assigned id. operationId: createIncentivizeAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: action_name: action_name component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true incentivize_action_type: CLICK overrides: overrides_key: overrides_key quality: ALWAYS review_status: EVALUATING schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' 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_controller_action_incentivize_action_name_invalid_expression: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_expression' campaign_controller_action_incentivize_action_name_invalid_length: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_length' campaign_controller_action_incentivize_action_name_invalid_value: $ref: '#/components/examples/campaign_controller_action_incentivize_action_name_invalid_value' campaign_controller_action_incentivize_action_type_missing: $ref: '#/components/examples/campaign_controller_action_incentivize_action_type_missing' campaign_controller_action_incentivize_override_value_invalid: $ref: '#/components/examples/campaign_controller_action_incentivize_override_value_invalid' campaign_controller_action_incentivize_override_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_incentivize_override_value_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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 an incentivize action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards: post: description: Adds a redeem-reward action to the specified campaign controller. When the controller's triggers fire, this action marks a reward as redeemed by the participant. Returns the created redeem-reward action with its server-assigned id. operationId: createRedeemRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: data_key enabled: true event_time: '2025-10-24T09:00:00.000Z' partner_event_id: partner_event_id quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' 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_controller_action_redeem_reward_data_attribute_name_invalid: $ref: '#/components/examples/campaign_controller_action_redeem_reward_data_attribute_name_invalid' campaign_controller_action_redeem_reward_data_attribute_value_invalid: $ref: '#/components/examples/campaign_controller_action_redeem_reward_data_attribute_value_invalid' campaign_controller_action_redeem_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_invalid_expression' campaign_controller_action_redeem_reward_missing_reward_id: $ref: '#/components/examples/campaign_controller_action_redeem_reward_missing_reward_id' campaign_controller_action_redeem_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_too_long_expression' campaign_controller_action_redeem_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_redeem_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 redeem-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships: post: description: Adds a remove-membership action to the specified campaign controller. When the controller's triggers fire, this action removes the participant from the specified audience. Returns the created remove-membership action with its server-assigned id. operationId: createRemoveMembershipAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: audience_id: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' 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_controller_action_remove_membership_audience_not_found: $ref: '#/components/examples/campaign_controller_action_remove_membership_audience_not_found' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 remove-membership action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards: post: description: Adds a revoke-reward action to the specified campaign controller. When the controller's triggers fire, this action revokes a previously issued reward, marking it as invalidated. Returns the created revoke-reward action with its server-assigned id. operationId: createRevokeRewardAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true message: message quality: ALWAYS reward_id: reward_id schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' 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_controller_action_revoke_reward_invalid_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_invalid_expression' campaign_controller_action_revoke_reward_missing_reward_id: $ref: '#/components/examples/campaign_controller_action_revoke_reward_missing_reward_id' campaign_controller_action_revoke_reward_too_long_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_too_long_expression' campaign_controller_action_revoke_reward_undefined_expression: $ref: '#/components/examples/campaign_controller_action_revoke_reward_undefined_expression' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 revoke-reward action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules: post: description: Adds a schedule action to the specified campaign controller. When the controller's triggers fire, this action schedules the configured action to fire at a future date and time. Returns the created schedule action with its server-assigned id. operationId: createScheduleAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} dates: - '2025-10-24T02:00:00-07:00' delays: - PT42S enabled: true extra_data: extra_data_key: {} force: true quality: ALWAYS schedule_name: schedule_name schema: $ref: '#/components/schemas/CampaignControllerActionScheduleCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' 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_controller_action_schedule_backdated_date_not_allowed: $ref: '#/components/examples/campaign_controller_action_schedule_backdated_date_not_allowed' campaign_controller_action_schedule_data_entry_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_schedule_data_entry_name_out_of_range' campaign_controller_action_schedule_delays_and_dates_not_supported_together: $ref: '#/components/examples/campaign_controller_action_schedule_delays_and_dates_not_supported_together' campaign_controller_action_schedule_duplicate_data_entry_name: $ref: '#/components/examples/campaign_controller_action_schedule_duplicate_data_entry_name' campaign_controller_action_schedule_invalid_date: $ref: '#/components/examples/campaign_controller_action_schedule_invalid_date' campaign_controller_action_schedule_invalid_delay: $ref: '#/components/examples/campaign_controller_action_schedule_invalid_delay' campaign_controller_action_schedule_missing_schedule_name: $ref: '#/components/examples/campaign_controller_action_schedule_missing_schedule_name' campaign_controller_action_schedule_name_contains_illegal_character: $ref: '#/components/examples/campaign_controller_action_schedule_name_contains_illegal_character' campaign_controller_action_schedule_name_out_of_range: $ref: '#/components/examples/campaign_controller_action_schedule_name_out_of_range' campaign_controller_action_schedule_negative_delay: $ref: '#/components/examples/campaign_controller_action_schedule_negative_delay' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 schedule action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events: post: description: Adds a share-event action to the specified campaign controller. When the controller's triggers fire, this action records a share event for the participant in the campaign pipeline. Returns the created share-event action with its server-assigned id. operationId: createShareEventAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionShareEventRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' 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_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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 share-event action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals: post: description: Adds a signal action to the specified campaign controller. When the controller's triggers fire, this action fires the configured signal event into the campaign event pipeline. Returns the created signal action with its server-assigned id. operationId: createSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true name: name quality: ALWAYS signal_polling_id: signal_polling_id schema: $ref: '#/components/schemas/CampaignControllerActionSignalCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' name_length_invalid: $ref: '#/components/examples/name_length_invalid' 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' signal_polling_id_length_invalid: $ref: '#/components/examples/signal_polling_id_length_invalid' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1: post: description: Adds a signal-v1 action to the specified campaign controller. When the controller's triggers fire, this action fires a legacy v1 signal event into the campaign pipeline (deprecated; prefer signal action). Returns the created signal-v1 action with its server-assigned id. operationId: createSignalV1Action parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: data_key enabled: true quality: ALWAYS signal_polling_id: signal_polling_id schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1CreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' 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_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' campaign_controller_action_signal_data_attribute_name_invalid: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_name_invalid' campaign_controller_action_signal_data_attribute_name_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_name_length_out_of_range' campaign_controller_action_signal_data_attribute_value_invalid: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_value_invalid' campaign_controller_action_signal_data_attribute_value_length_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_data_attribute_value_length_out_of_range' campaign_controller_action_signal_signal_polling_id_out_of_range: $ref: '#/components/examples/campaign_controller_action_signal_signal_polling_id_out_of_range' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 signal-v1 action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals: post: description: Adds a step-signal action to the specified campaign controller. When the controller's triggers fire, this action fires a step-scoped signal, advancing the participant within the configured flow step. Returns the created step-signal action with its server-assigned id. operationId: createStepSignalAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name enabled: true name: name polling_id: polling_id quality: ALWAYS schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' 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_controller_action_step_signal_name_invalid_length: $ref: '#/components/examples/campaign_controller_action_step_signal_name_invalid_length' campaign_controller_action_step_signal_polling_id_invalid_expression: $ref: '#/components/examples/campaign_controller_action_step_signal_polling_id_invalid_expression' campaign_controller_action_step_signal_polling_id_invalid_length: $ref: '#/components/examples/campaign_controller_action_step_signal_polling_id_invalid_length' 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' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 step-signal action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert /v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks: post: description: Adds a webhook action to the specified campaign controller. When the controller's triggers fire, this action posts the configured payload to the configured external webhook URL. Returns the created webhook action with its server-assigned id. operationId: createWebhookAction parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string - in: path name: controllerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data: data_key: {} enabled: true quality: ALWAYS webhook_id: {} schema: $ref: '#/components/schemas/CampaignControllerActionWebhookCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' 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' data_name_invalid: $ref: '#/components/examples/data_name_invalid' data_name_length_invalid: $ref: '#/components/examples/data_name_length_invalid' data_value_invalid: $ref: '#/components/examples/data_value_invalid' data_value_length_invalid: $ref: '#/components/examples/data_value_length_invalid' 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' webhook_missing: $ref: '#/components/examples/webhook_missing' webhook_not_found: $ref: '#/components/examples/webhook_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' invalid_campaign_controller_id: $ref: '#/components/examples/invalid_campaign_controller_id' invalid_controller_action_id: $ref: '#/components/examples/invalid_controller_action_id' invalid_controller_trigger_id: $ref: '#/components/examples/invalid_controller_trigger_id' 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 webhook action tags: - Campaign Controllers Actions x-extole-bundle: management-expert x-extole-visibility: expert components: schemas: DataInCampaignControllerActionWebhookUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionSignalUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionScheduleResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventNameInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic event name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ResponseInCampaignControllerActionDisplayResponse: description: 'The response as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Literal response title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{response}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('response');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignControllerActionSignalResponse: description: 'The name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ScheduleNameInCampaignControllerActionScheduleResponse: description: 'The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal schedule name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{scheduleName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('scheduleName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignControllerActionSignalCreateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static name title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The message as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal message title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTimeInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInCampaignControllerActionEarnRewardResponse: description: 'The tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionSignalCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionIncentivizeResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_name: type: string action_type: enum: - INCENTIVIZE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeResponse' incentivize_action_type: $ref: '#/components/schemas/IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse' overrides: additionalProperties: type: string type: object review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeResponse' type: object type: object DataInBuiltCampaignControllerActionEmailResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionExpressionUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionFulfillRewardUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic value of event being rewarded oneOf: - description: Static value of event being rewarded nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{valueOfEventBeingRewarded}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('valueOfEventBeingRewarded');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardActionIdInCampaignControllerActionEarnRewardResponse: description: 'The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward action id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionScheduleResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic legacy action id oneOf: - description: Static legacy action id nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{legacyActionId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('legacyActionId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionEarnRewardResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MessageInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic message oneOf: - description: Static message nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{message}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('message');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionCreativeUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTimeInCampaignControllerActionRedeemRewardCreateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionResponseBase: description: 'The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string Instant: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.' example: '2025-10-24T09:00:00.000Z' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$ type: string EventTimeInCampaignControllerActionEarnRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BodyInCampaignControllerActionDisplayCreateRequest: description: Choose between static or dynamic body oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static body title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{body}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('body');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDeclineResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DECLINE type: string cause_type: type: string event_type: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string type: object type: object WebhookIdInCampaignControllerActionWebhookUpdateRequest: description: Choose between static or dynamic webhook id oneOf: - description: Static webhook id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{webhookId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('webhookId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DatesInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic dates oneOf: - description: Static dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{dates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('dates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionRedeemRewardUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The event type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionIncentivizeCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionScheduleCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/schedules` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionScheduleCreateRequest' dates: $ref: '#/components/schemas/DatesInCampaignControllerActionScheduleCreateRequest' delays: $ref: '#/components/schemas/DelaysInCampaignControllerActionScheduleCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionScheduleCreateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionScheduleCreateRequest' force: type: boolean quality: enum: - ALWAYS - HIGH - LOW type: string schedule_name: $ref: '#/components/schemas/ScheduleNameInCampaignControllerActionScheduleCreateRequest' type: object EventTimeInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionEarnRewardUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEarnRewardUpdateRequest' type: object EnabledInCampaignControllerActionDeclineCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionCreativeResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CREATIVE type: string api_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string has_creative: type: boolean latest_version: format: int32 type: integer output: additionalProperties: items: type: string type: array type: object theme_version: type: string type: object type: object DataInCampaignControllerActionWebhookResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionRedeemRewardCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTimeInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static event time title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventTime}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventTime');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionEarnRewardResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEarnRewardResponse' type: object DataInCampaignControllerActionEmailResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ReviewStatusInCampaignControllerActionIncentivizeCreateRequest: description: Choose between static or dynamic review status oneOf: - description: Static review status enum: - EVALUATING - PENDING title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionExpressionUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionExpressionUpdateRequest' type: object CampaignControllerActionWebhookUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/webhooks/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionWebhookUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionWebhookUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignControllerActionWebhookUpdateRequest' type: object ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object EnabledInCampaignControllerActionRevokeRewardCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PersonIdInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MessageInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic message oneOf: - description: Static message nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{message}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('message');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDisplayUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/displays/{actionId}` request. properties: body: $ref: '#/components/schemas/BodyInCampaignControllerActionDisplayUpdateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionDisplayUpdateRequest' headers: $ref: '#/components/schemas/HeadersInCampaignControllerActionDisplayUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string response: $ref: '#/components/schemas/ResponseInCampaignControllerActionDisplayUpdateRequest' type: object ZoneNameInCampaignControllerActionEmailResponse: description: 'The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal zone name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{zoneName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('zoneName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionExpressionCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FireAsPersonIdentificationBase: properties: person_identification_type: enum: - EMAIL - PARTNER_EVENT_ID - PARTNER_USER_ID - PERSON_ID type: string value: type: string type: object EnabledInCampaignControllerActionRemoveMembershipUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionExpressionCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionExpressionCreateRequest' type: object ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal review status title: Static Value - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The move to pending as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal move to pending title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{moveToPending}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('moveToPending');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdInCampaignControllerActionRemoveMembershipResponse: description: 'The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal audience id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FireAsPersonJourney: properties: advocate_code: type: string advocate_partner_user_id: type: string campaign_id: type: string container: type: string coupon_code: type: string journey_type: type: string label: type: string promotable_code: type: string reason: type: string referral_reason: enum: - ADVOCATE - ADVOCATE_CODE - ADVOCATE_PARTNER_USER_ID - COUPON_CODE - DISPLACED_PARTNER_USER_ID - INCENTIVIZED_SHARE - PARTNER_EVENT_ID - PARTNER_SHARE_ID - SHAREABLE_ID - SHARE_ID - SHARE_RECIPIENT - UNKNOWN_REASON type: string share_id: type: string shareable_id: type: string zone: type: string type: object CampaignControllerActionRemoveMembershipResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REMOVE_MEMBERSHIP type: string audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionRemoveMembershipResponse' type: object type: object PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic partner event id oneOf: - description: Static partner event id nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{partnerEventId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('partnerEventId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ScheduleNameInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic schedule name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static schedule name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{scheduleName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('scheduleName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ReviewStatusInCampaignControllerActionIncentivizeUpdateRequest: description: Choose between static or dynamic review status oneOf: - description: Static review status enum: - EVALUATING - PENDING title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ExpressionInCampaignControllerActionExpressionUpdateRequest: description: Choose between static or dynamic expression oneOf: - description: Static expression title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionExpressionUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionCancelRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CANCEL_REWARD type: string message: type: string reward_id: type: string type: object type: object CampaignControllerActionRevokeRewardCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/revoke-rewards` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRevokeRewardCreateRequest' message: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object SlotsInCampaignControllerActionEarnRewardResponse: description: 'The slots as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{slots}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('slots');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionSignalV1UpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionIncentivizeResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeResponse' type: object DatesInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic dates oneOf: - description: Static dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{dates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('dates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionResponse: description: Stored campaign controller action definition. Field `enabled` is unevaluated and appears in buildtime-evaluatable form. discriminator: mapping: APPROVE: '#/components/schemas/CampaignControllerActionApproveResponse' CANCEL_REWARD: '#/components/schemas/CampaignControllerActionCancelRewardResponse' CREATE_MEMBERSHIP: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' CREATIVE: '#/components/schemas/CampaignControllerActionCreativeResponse' DATA_INTELLIGENCE: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' DECLINE: '#/components/schemas/CampaignControllerActionDeclineResponse' DISPLAY: '#/components/schemas/CampaignControllerActionDisplayResponse' EARN_REWARD: '#/components/schemas/CampaignControllerActionEarnRewardResponse' EMAIL: '#/components/schemas/CampaignControllerActionEmailResponse' EXPRESSION: '#/components/schemas/CampaignControllerActionExpressionResponse' FIRE_AS_PERSON: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' FULFILL_REWARD: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' INCENTIVIZE: '#/components/schemas/CampaignControllerActionIncentivizeResponse' INCENTIVIZE_STATUS_UPDATE: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' REDEEM_REWARD: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' REMOVE_MEMBERSHIP: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' REVOKE_REWARD: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' SCHEDULE: '#/components/schemas/CampaignControllerActionScheduleResponse' SHARE_EVENT: '#/components/schemas/CampaignControllerActionShareEventResponse' SIGNAL: '#/components/schemas/CampaignControllerActionSignalResponse' SIGNAL_V1: '#/components/schemas/CampaignControllerActionSignalV1Response' STEP_SIGNAL: '#/components/schemas/CampaignControllerActionStepSignalResponse' WEBHOOK: '#/components/schemas/CampaignControllerActionWebhookResponse' propertyName: action_type oneOf: - $ref: '#/components/schemas/CampaignControllerActionApproveResponse' - $ref: '#/components/schemas/CampaignControllerActionCancelRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionCreateMembershipResponse' - $ref: '#/components/schemas/CampaignControllerActionCreativeResponse' - $ref: '#/components/schemas/CampaignControllerActionDataIntelligenceResponse' - $ref: '#/components/schemas/CampaignControllerActionDeclineResponse' - $ref: '#/components/schemas/CampaignControllerActionDisplayResponse' - $ref: '#/components/schemas/CampaignControllerActionEarnRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionEmailResponse' - $ref: '#/components/schemas/CampaignControllerActionExpressionResponse' - $ref: '#/components/schemas/CampaignControllerActionFireAsPersonResponse' - $ref: '#/components/schemas/CampaignControllerActionFulfillRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionIncentivizeResponse' - $ref: '#/components/schemas/CampaignControllerActionIncentivizeStatusUpdateResponse' - $ref: '#/components/schemas/CampaignControllerActionRedeemRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionRemoveMembershipResponse' - $ref: '#/components/schemas/CampaignControllerActionRevokeRewardResponse' - $ref: '#/components/schemas/CampaignControllerActionScheduleResponse' - $ref: '#/components/schemas/CampaignControllerActionShareEventResponse' - $ref: '#/components/schemas/CampaignControllerActionSignalResponse' - $ref: '#/components/schemas/CampaignControllerActionSignalV1Response' - $ref: '#/components/schemas/CampaignControllerActionStepSignalResponse' - $ref: '#/components/schemas/CampaignControllerActionWebhookResponse' required: - action_id - action_type - component_ids - component_references - enabled - quality PartnerEventIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: partner_event_key: type: string person_identification_type: enum: - PARTNER_EVENT_ID type: string type: object type: object CampaignControllerActionDeclineUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/declines/{actionId}` request. properties: cause_type: type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionDeclineUpdateRequest' event_type: type: string legacy_action_id: nullable: true type: string note: nullable: true type: string partner_event_id: type: string polling_id: nullable: true type: string polling_name: type: string quality: enum: - ALWAYS - HIGH - LOW type: string type: object DataMapInCampaignControllerActionScheduleUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionScheduleUpdateRequest' type: object EnabledInCampaignControllerActionDisplayCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ExtraDataInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionFireAsPersonResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionFireAsPersonResponse' type: object DataInCampaignControllerActionEarnRewardResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionSignalV1CreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionCreateMembershipUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTimeInCampaignControllerActionFireAsPersonResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal event time title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventTime}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventTime');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionWebhookUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionIncentivizeUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionApproveUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdInCampaignControllerActionCreateMembershipResponse: description: 'The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal audience id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionShareEventRequest: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionShareEventRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object EventTimeInCampaignControllerActionRedeemRewardUpdateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BodyInCampaignControllerActionDisplayUpdateRequest: description: Choose between static or dynamic body oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static body title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{body}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('body');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeStatusUpdateResponse' type: object CampaignControllerActionRedeemRewardCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/redeem-rewards` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: additionalProperties: type: string type: object enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRedeemRewardCreateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionRedeemRewardCreateRequest' partner_event_id: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object SignalPollingIdInCampaignControllerActionSignalCreateRequest: description: Choose between static or dynamic signal polling id oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static signal polling id title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionRedeemRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REDEEM_REWARD type: string data: additionalProperties: type: string type: object event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionRedeemRewardResponse' partner_event_id: type: string reward_id: type: string type: object type: object PartnerUserIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PARTNER_USER_ID type: string type: object ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic value of event being rewarded oneOf: - description: Static value of event being rewarded nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{valueOfEventBeingRewarded}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('valueOfEventBeingRewarded');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string IntelligenceProviderInCampaignControllerActionDataIntelligenceRequest: description: Choose between static or dynamic intelligence provider oneOf: - description: Static intelligence provider enum: - EMAIL_AGE - MAXMIND - NOOP title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{intelligenceProvider}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('intelligenceProvider');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionSignalV1Response: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL_V1 type: string data: additionalProperties: type: string type: object signal_polling_id: type: string type: object type: object DataMapInCampaignControllerActionIncentivizeUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeUpdateRequest' type: object RewardSupplierIdInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic reward supplier id oneOf: - description: Static reward supplier id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardSupplierId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardSupplierId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic partner event id oneOf: - description: Static partner event id nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{partnerEventId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('partnerEventId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionEmailUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionFulfillRewardUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fulfill-rewards/{actionId}` request. properties: amount: $ref: '#/components/schemas/AmountInCampaignControllerActionFulfillRewardUpdateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionFulfillRewardUpdateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFulfillRewardUpdateRequest' message: nullable: true type: string partner_reward_id: $ref: '#/components/schemas/PartnerRewardIdInCampaignControllerActionFulfillRewardUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string success: nullable: true type: string type: object CampaignControllerActionFireAsPersonUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fire-as-person/{actionId}` request. properties: as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionFireAsPersonUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionFireAsPersonUpdateRequest' event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionFireAsPersonUpdateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFireAsPersonUpdateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionFireAsPersonUpdateRequest' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerActionFireAsPersonUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object RewardTagsInCampaignControllerActionApproveUpdateRequest: description: Choose between static or dynamic reward tags oneOf: - description: Static reward tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardTags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardTags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionShareEventRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner event id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{partnerEventId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('partnerEventId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionScheduleResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionScheduleResponse' type: object ResponseInBuiltCampaignControllerActionDisplayResponse: description: 'The response as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Literal response title: Static Value - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTimeInCampaignControllerActionFulfillRewardUpdateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionFulfillRewardCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fulfill-rewards` request. properties: amount: $ref: '#/components/schemas/AmountInCampaignControllerActionFulfillRewardCreateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionFulfillRewardCreateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFulfillRewardCreateRequest' message: nullable: true type: string partner_reward_id: $ref: '#/components/schemas/PartnerRewardIdInCampaignControllerActionFulfillRewardCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string success: nullable: true type: string type: object EnabledInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionCancelRewardCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/cancel-rewards` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCancelRewardCreateRequest' message: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object AudienceIdInCampaignControllerActionRemoveMembershipCreateRequest: description: Choose between static or dynamic audience id oneOf: - description: Static audience id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionWebhookCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' type: object EnabledInCampaignControllerActionCancelRewardCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdInCampaignControllerActionRemoveMembershipUpdateRequest: description: Choose between static or dynamic audience id oneOf: - description: Static audience id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionSignalCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionSignalCreateRequest' type: object AmountInCampaignControllerActionFulfillRewardUpdateRequest: description: Choose between static or dynamic amount oneOf: - description: Static amount nullable: true title: Static Value type: object - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{amount}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('amount');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic person id oneOf: - description: Static person id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{personId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionFulfillRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - FULFILL_REWARD type: string event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFulfillRewardResponse' message: type: string partner_reward_id: $ref: '#/components/schemas/PartnerRewardIdInCampaignControllerActionFulfillRewardResponse' reward_id: type: string success: type: string type: object type: object CampaignControllerActionCreateMembershipUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/create-memberships/{actionId}` request. properties: audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionCreateMembershipUpdateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCreateMembershipUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object CampaignControllerActionStepSignalCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/step-signals` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionStepSignalCreateRequest' name: type: string polling_id: type: string quality: enum: - ALWAYS - HIGH - LOW type: string type: object EventTimeInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal event time title: Static Value - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' event_type: $ref: '#/components/schemas/EventTypeInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' message: $ref: '#/components/schemas/MessageInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' move_to_pending: $ref: '#/components/schemas/MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' partner_event_id: $ref: '#/components/schemas/PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' type: object WebhookIdInCampaignControllerActionWebhookCreateRequest: description: Choose between static or dynamic webhook id oneOf: - description: Static webhook id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{webhookId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('webhookId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionIncentivizeResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionCreativeCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/creatives` request. properties: api_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCreativeCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string theme_version: type: string type: object ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic review status oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static review status title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionWebhookResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - WEBHOOK type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionWebhookResponse' webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignControllerActionWebhookResponse' type: object type: object EventTimeInCampaignControllerActionFireAsPersonUpdateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static event time title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventTime}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventTime');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionResponseBase: properties: action_id: type: string action_type: enum: - APPROVE - CANCEL_REWARD - CREATE_MEMBERSHIP - CREATIVE - DATA_INTELLIGENCE - DECLINE - DISPLAY - EARN_REWARD - EMAIL - EXPRESSION - FIRE_AS_PERSON - FULFILL_REWARD - INCENTIVIZE - INCENTIVIZE_STATUS_UPDATE - REDEEM_REWARD - REMOVE_MEMBERSHIP - REVOKE_REWARD - SCHEDULE - SHARE_EVENT - SIGNAL - SIGNAL_V1 - STEP_SIGNAL - WEBHOOK type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionResponseBase' quality: enum: - ALWAYS - HIGH - LOW type: string type: object RewardNameInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic reward name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static reward name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AudienceIdInCampaignControllerActionCreateMembershipCreateRequest: description: Choose between static or dynamic audience id oneOf: - description: Static audience id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ScheduleNameInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic schedule name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static schedule name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{scheduleName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('scheduleName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ZoneNameInCampaignControllerActionEmailUpdateRequest: description: Choose between static or dynamic zone name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static zone name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{zoneName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('zoneName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string HeadersInCampaignControllerActionDisplayCreateRequest: description: Choose between static or dynamic headers oneOf: - additionalProperties: type: string description: Static headers title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{headers}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('headers');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic move to pending oneOf: - description: Static move to pending title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{moveToPending}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('moveToPending');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerActionIncentivizeResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_name: type: string action_type: enum: - INCENTIVIZE type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeResponse' incentivize_action_type: enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string overrides: additionalProperties: type: string type: object review_status: enum: - EVALUATING - PENDING type: string type: object type: object DataMapInCampaignControllerActionWebhookCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionWebhookCreateRequest' type: object EnabledInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionRemoveMembershipCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionSignalResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionFireAsPersonUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionFireAsPersonUpdateRequest' type: object CampaignControllerActionIncentivizeCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivizes` request. properties: action_name: nullable: true type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionIncentivizeCreateRequest' incentivize_action_type: $ref: '#/components/schemas/IncentivizeActionTypeInCampaignControllerActionIncentivizeCreateRequest' overrides: additionalProperties: type: string type: object quality: enum: - ALWAYS - HIGH - LOW type: string review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeCreateRequest' type: object CampaignControllerActionCreativeUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/creatives/{actionId}` request. properties: api_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCreativeUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string theme_version: type: string type: object DataMapInCampaignControllerActionEarnRewardCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEarnRewardCreateRequest' type: object AudienceIdInCampaignControllerActionCreateMembershipUpdateRequest: description: Choose between static or dynamic audience id oneOf: - description: Static audience id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{audienceId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('audienceId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionSignalUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal legacy action id title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionApproveCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PartnerRewardIdInCampaignControllerActionFulfillRewardResponse: description: 'The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner reward id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionStepSignalResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - STEP_SIGNAL type: string name: type: string polling_id: type: string type: object type: object DataMapInCampaignControllerActionWebhookResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionWebhookResponse' type: object CampaignControllerActionIncentivizeStatusUpdateResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - INCENTIVIZE_STATUS_UPDATE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse' event_type: $ref: '#/components/schemas/EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse' message: $ref: '#/components/schemas/MessageInCampaignControllerActionIncentivizeStatusUpdateResponse' move_to_pending: $ref: '#/components/schemas/MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse' partner_event_id: $ref: '#/components/schemas/PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse' review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse' type: object type: object EventNameInCampaignControllerActionFireAsPersonResponse: description: 'The event name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardSupplierIdInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic reward supplier id oneOf: - description: Static reward supplier id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardSupplierId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardSupplierId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionFireAsPersonCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionFireAsPersonCreateRequest' type: object DataInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ResponseInCampaignControllerActionDisplayCreateRequest: description: Choose between static or dynamic response oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Static response title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{response}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('response');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionCreativeCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic review status oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static review status title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionFireAsPersonResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionEmailResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEmailResponse' type: object PersonIdInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic person id oneOf: - description: Static person id nullable: true title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{personId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionShareEventResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SHARE_EVENT type: string type: object type: object DataInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse: description: 'The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal value of event being rewarded title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{valueOfEventBeingRewarded}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('valueOfEventBeingRewarded');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardActionIdInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic reward action id oneOf: - description: Static reward action id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionScheduleCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionScheduleCreateRequest' type: object ResponseInCampaignControllerActionDisplayUpdateRequest: description: Choose between static or dynamic response oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Static response title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{response}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('response');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionDeclineUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionRemoveMembershipUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/remove-memberships/{actionId}` request. properties: audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionRemoveMembershipUpdateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRemoveMembershipUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object DataInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string NameInCampaignControllerActionSignalUpdateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static name title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BodyInBuiltCampaignControllerActionDisplayResponse: description: 'The body as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal body title: Static Value - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardNameInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic reward name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static reward name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EmailFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - EMAIL type: string type: object DataInCampaignControllerActionExpressionResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionIncentivizeResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionIncentivizeResponse' type: object RewardActionIdInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic reward action id oneOf: - description: Static reward action id title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTimeInCampaignControllerActionRedeemRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionScheduleResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SCHEDULE type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionScheduleResponse' dates: $ref: '#/components/schemas/DatesInCampaignControllerActionScheduleResponse' delays: $ref: '#/components/schemas/DelaysInCampaignControllerActionScheduleResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionScheduleResponse' force: type: boolean schedule_name: $ref: '#/components/schemas/ScheduleNameInCampaignControllerActionScheduleResponse' type: object type: object DataMapInCampaignControllerActionSignalUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionSignalUpdateRequest' type: object EnabledInCampaignControllerActionDataIntelligenceRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardTagsInCampaignControllerActionApproveResponse: description: 'The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardTags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardTags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInCampaignControllerActionWebhookUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionWebhookUpdateRequest' type: object SlotsInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic slots oneOf: - description: Static slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{slots}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('slots');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDisplayCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/displays` request. properties: body: $ref: '#/components/schemas/BodyInCampaignControllerActionDisplayCreateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionDisplayCreateRequest' headers: $ref: '#/components/schemas/HeadersInCampaignControllerActionDisplayCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string response: $ref: '#/components/schemas/ResponseInCampaignControllerActionDisplayCreateRequest' type: object CampaignControllerActionSignalV1UpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals-v1/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: additionalProperties: type: string type: object enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionSignalV1UpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string signal_polling_id: type: string type: object DataInCampaignControllerActionExpressionCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionEarnRewardUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionIncentivizeUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionRevokeRewardUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/revoke-rewards/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRevokeRewardUpdateRequest' message: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal legacy action id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{legacyActionId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('legacyActionId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ApiResponse: properties: body: type: string headers: additionalProperties: type: string type: object statusCode: format: int32 type: integer type: object DataMapInBuiltCampaignControllerActionEmailResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionEmailResponse' type: object EnabledInCampaignControllerActionCreateMembershipCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionCreateMembershipCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/create-memberships` request. properties: audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionCreateMembershipCreateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCreateMembershipCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object SignalPollingIdInCampaignControllerActionSignalResponse: description: 'The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal signal polling id title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string Duration: description: '[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.' example: PT42S pattern: ^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$ type: string PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal partner event id title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionFireAsPersonResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - FIRE_AS_PERSON type: string as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' data: $ref: '#/components/schemas/DataMapInCampaignControllerActionFireAsPersonResponse' event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionFireAsPersonResponse' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFireAsPersonResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionFireAsPersonResponse' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerActionFireAsPersonResponse' type: object type: object EventTypeInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic event type oneOf: - description: Static event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic extra data oneOf: - additionalProperties: type: object description: Static extra data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{extraData}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('extraData');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionExpressionResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EXPRESSION type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionExpressionResponse' expression: $ref: '#/components/schemas/ExpressionInCampaignControllerActionExpressionResponse' type: object type: object CampaignControllerActionStepSignalUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/step-signals/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionStepSignalUpdateRequest' name: type: string polling_id: type: string quality: enum: - ALWAYS - HIGH - LOW type: string type: object DataMapInCampaignControllerActionEmailUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEmailUpdateRequest' type: object CampaignControllerActionDataIntelligenceResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DATA_INTELLIGENCE type: string event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionDataIntelligenceResponse' intelligence_provider: $ref: '#/components/schemas/IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse' profile_risk_update_interval: $ref: '#/components/schemas/ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse' type: object type: object EnabledInCampaignControllerActionFulfillRewardCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInCampaignControllerActionEmailUpdateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDisplayResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - DISPLAY type: string body: $ref: '#/components/schemas/BodyInCampaignControllerActionDisplayResponse' headers: $ref: '#/components/schemas/HeadersInCampaignControllerActionDisplayResponse' response: $ref: '#/components/schemas/ResponseInCampaignControllerActionDisplayResponse' type: object type: object CampaignControllerActionEmailUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/emails/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEmailUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionEmailUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string zone_name: $ref: '#/components/schemas/ZoneNameInCampaignControllerActionEmailUpdateRequest' type: object DataMapInBuiltCampaignControllerActionFireAsPersonResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionFireAsPersonResponse' type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: Attributes related to the error, varies be error code, documented per endpoint type: object description: Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object CampaignControllerActionEmailResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EMAIL type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEmailResponse' zone_name: $ref: '#/components/schemas/ZoneNameInCampaignControllerActionEmailResponse' type: object type: object CampaignControllerActionEarnRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - EARN_REWARD type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEarnRewardResponse' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionEarnRewardResponse' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionEarnRewardResponse' reward_action_id: $ref: '#/components/schemas/RewardActionIdInCampaignControllerActionEarnRewardResponse' reward_name: $ref: '#/components/schemas/RewardNameInCampaignControllerActionEarnRewardResponse' reward_supplier_id: $ref: '#/components/schemas/RewardSupplierIdInCampaignControllerActionEarnRewardResponse' slots: $ref: '#/components/schemas/SlotsInCampaignControllerActionEarnRewardResponse' tags: $ref: '#/components/schemas/TagsInCampaignControllerActionEarnRewardResponse' value_of_event_being_rewarded: $ref: '#/components/schemas/ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse' type: object type: object DataMapInCampaignControllerActionSignalResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionSignalResponse' type: object DataMapInCampaignControllerActionIncentivizeCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeCreateRequest' type: object CampaignControllerActionRedeemRewardUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/redeem-rewards/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: additionalProperties: type: string type: object enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRedeemRewardUpdateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionRedeemRewardUpdateRequest' partner_event_id: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object TagsInCampaignControllerActionEarnRewardUpdateRequest: 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 [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object CampaignControllerActionSignalCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionSignalCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionSignalCreateRequest' name: $ref: '#/components/schemas/NameInCampaignControllerActionSignalCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string signal_polling_id: $ref: '#/components/schemas/SignalPollingIdInCampaignControllerActionSignalCreateRequest' type: object ReviewStatusInCampaignControllerActionIncentivizeResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal review status enum: - EVALUATING - PENDING title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DelaysInCampaignControllerActionScheduleResponse: description: 'The delays as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{delays}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('delays');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTypeInCampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Choose between static or dynamic event type oneOf: - description: Static event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInCampaignControllerActionFireAsPersonResponse: description: 'The person id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal person id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{personId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('personId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FireAsPersonIdentification: discriminator: mapping: EMAIL: '#/components/schemas/EmailFireAsPersonIdentification' PARTNER_EVENT_ID: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' PARTNER_USER_ID: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' PERSON_ID: '#/components/schemas/PersonIdFireAsPersonIdentification' propertyName: person_identification_type oneOf: - $ref: '#/components/schemas/EmailFireAsPersonIdentification' - $ref: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' - $ref: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' - $ref: '#/components/schemas/PersonIdFireAsPersonIdentification' CampaignControllerActionCancelRewardUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/cancel-rewards/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionCancelRewardUpdateRequest' message: nullable: true type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_id: type: string type: object HeadersInCampaignControllerActionDisplayUpdateRequest: description: Choose between static or dynamic headers oneOf: - additionalProperties: type: string description: Static headers title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{headers}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('headers');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionSignalV1CreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals-v1` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: additionalProperties: type: string type: object enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionSignalV1CreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string signal_polling_id: type: string type: object BuiltCampaignControllerActionDisplayResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DISPLAY type: string body: $ref: '#/components/schemas/BodyInBuiltCampaignControllerActionDisplayResponse' headers: $ref: '#/components/schemas/HeadersInBuiltCampaignControllerActionDisplayResponse' response: $ref: '#/components/schemas/ResponseInBuiltCampaignControllerActionDisplayResponse' type: object type: object ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The review status as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal review status title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{reviewStatus}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('reviewStatus');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerActionEmailResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EMAIL type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionEmailResponse' zone_name: type: string type: object type: object DatesInCampaignControllerActionScheduleResponse: description: 'The dates as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{dates}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('dates');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionExpressionUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/expressions/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionExpressionUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionExpressionUpdateRequest' expression: $ref: '#/components/schemas/ExpressionInCampaignControllerActionExpressionUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object CampaignControllerActionApproveUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/approves/{actionId}` request. properties: cause_type: type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionApproveUpdateRequest' event_type: type: string force: type: string legacy_action_id: nullable: true type: string note: nullable: true type: string partner_event_id: type: string polling_id: nullable: true type: string polling_name: type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_tags: $ref: '#/components/schemas/RewardTagsInCampaignControllerActionApproveUpdateRequest' type: object ExpressionInCampaignControllerActionExpressionCreateRequest: description: Choose between static or dynamic expression oneOf: - description: Static expression title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SignalPollingIdInCampaignControllerActionSignalUpdateRequest: description: Choose between static or dynamic signal polling id oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static signal polling id title: Static Value - description: Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventNameInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic event name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionSignalResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL type: string data: $ref: '#/components/schemas/DataMapInCampaignControllerActionSignalResponse' name: $ref: '#/components/schemas/NameInCampaignControllerActionSignalResponse' signal_polling_id: $ref: '#/components/schemas/SignalPollingIdInCampaignControllerActionSignalResponse' type: object type: object LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic legacy action id oneOf: - description: Static legacy action id nullable: true title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{legacyActionId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('legacyActionId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionIncentivizeCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string HeadersInBuiltCampaignControllerActionDisplayResponse: description: 'The headers as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: string description: Literal headers title: Static Value type: object - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardTagsInCampaignControllerActionApproveCreateRequest: description: Choose between static or dynamic reward tags oneOf: - description: Static reward tags items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardTags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardTags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerRewardIdInCampaignControllerActionFulfillRewardCreateRequest: description: Choose between static or dynamic partner reward id oneOf: - description: Static partner reward id nullable: true title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionRevokeRewardUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse: description: 'The incentivize action type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal incentivize action type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{incentivizeActionType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('incentivizeActionType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionExpressionResponse: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionExpressionResponse' type: object MessageInCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The message as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal message title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{message}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('message');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionIncentivizeStatusUpdateCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivize-status-updates` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' event_type: $ref: '#/components/schemas/EventTypeInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' message: $ref: '#/components/schemas/MessageInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' move_to_pending: $ref: '#/components/schemas/MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' partner_event_id: $ref: '#/components/schemas/PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateCreateRequest' type: object CampaignControllerActionEarnRewardCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/earn-rewards` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEarnRewardCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionEarnRewardCreateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionEarnRewardCreateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionEarnRewardCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string reward_action_id: $ref: '#/components/schemas/RewardActionIdInCampaignControllerActionEarnRewardCreateRequest' reward_name: $ref: '#/components/schemas/RewardNameInCampaignControllerActionEarnRewardCreateRequest' reward_supplier_id: $ref: '#/components/schemas/RewardSupplierIdInCampaignControllerActionEarnRewardCreateRequest' slots: $ref: '#/components/schemas/SlotsInCampaignControllerActionEarnRewardCreateRequest' tags: $ref: '#/components/schemas/TagsInCampaignControllerActionEarnRewardCreateRequest' value_of_event_being_rewarded: $ref: '#/components/schemas/ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardCreateRequest' type: object ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse: description: 'The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse: description: 'The intelligence provider as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal intelligence provider enum: - EMAIL_AGE - MAXMIND - NOOP title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{intelligenceProvider}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('intelligenceProvider');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionWebhookCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataMapInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest' type: object ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceRequest: description: Choose between static or dynamic profile risk update interval oneOf: - description: Static profile risk update interval properties: nano: format: int32 type: integer negative: type: boolean positive: type: boolean seconds: format: int64 type: integer units: items: properties: dateBased: type: boolean duration: $ref: '#/components/schemas/Duration' durationEstimated: type: boolean timeBased: type: boolean type: object type: array zero: type: boolean title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{profileRiskUpdateInterval}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('profileRiskUpdateInterval');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionStepSignalUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest: description: Choose between static or dynamic move to pending oneOf: - description: Static move to pending title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{moveToPending}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('moveToPending');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionSignalUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionSignalUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionSignalUpdateRequest' name: $ref: '#/components/schemas/NameInCampaignControllerActionSignalUpdateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string signal_polling_id: $ref: '#/components/schemas/SignalPollingIdInCampaignControllerActionSignalUpdateRequest' type: object CampaignControllerActionEarnRewardUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/earn-rewards/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEarnRewardUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionEarnRewardUpdateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionEarnRewardUpdateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionEarnRewardUpdateRequest' polling_id: type: string program_domain_id: type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_action_id: $ref: '#/components/schemas/RewardActionIdInCampaignControllerActionEarnRewardUpdateRequest' reward_name: $ref: '#/components/schemas/RewardNameInCampaignControllerActionEarnRewardUpdateRequest' reward_supplier_id: $ref: '#/components/schemas/RewardSupplierIdInCampaignControllerActionEarnRewardUpdateRequest' sandbox: type: string slots: $ref: '#/components/schemas/SlotsInCampaignControllerActionEarnRewardUpdateRequest' tags: $ref: '#/components/schemas/TagsInCampaignControllerActionEarnRewardUpdateRequest' value_of_event_being_rewarded: $ref: '#/components/schemas/ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardUpdateRequest' type: object ExpressionInCampaignControllerActionExpressionResponse: description: 'The expression as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal expression title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDeclineCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/declines` request. properties: cause_type: type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionDeclineCreateRequest' event_type: type: string legacy_action_id: nullable: true type: string note: nullable: true type: string partner_event_id: type: string polling_id: nullable: true type: string polling_name: type: string quality: enum: - ALWAYS - HIGH - LOW type: string type: object FileAttributes: properties: fileName: type: string size: format: int64 type: integer type: object BuiltCampaignControllerActionIncentivizeStatusUpdateResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - INCENTIVIZE_STATUS_UPDATE type: string data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' event_type: $ref: '#/components/schemas/EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' legacy_action_id: $ref: '#/components/schemas/LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' message: $ref: '#/components/schemas/MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' move_to_pending: type: boolean partner_event_id: $ref: '#/components/schemas/PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' review_status: $ref: '#/components/schemas/ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' type: object type: object RewardNameInCampaignControllerActionEarnRewardResponse: description: 'The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal reward name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionApproveCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/approves` request. properties: cause_type: type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionApproveCreateRequest' event_type: type: string force: type: string legacy_action_id: nullable: true type: string note: nullable: true type: string partner_event_id: type: string polling_id: nullable: true type: string polling_name: type: string quality: enum: - ALWAYS - HIGH - LOW type: string reward_tags: $ref: '#/components/schemas/RewardTagsInCampaignControllerActionApproveCreateRequest' type: object CampaignControllerActionRevokeRewardResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - REVOKE_REWARD type: string message: type: string reward_id: type: string type: object type: object EnabledInCampaignControllerActionStepSignalCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BodyInCampaignControllerActionDisplayResponse: description: 'The body as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal body title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{body}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('body');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CampaignControllerActionApproveResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - APPROVE type: string cause_type: type: string event_type: type: string force: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string reward_tags: $ref: '#/components/schemas/RewardTagsInCampaignControllerActionApproveResponse' type: object type: object PartnerRewardIdInCampaignControllerActionFulfillRewardUpdateRequest: description: Choose between static or dynamic partner reward id oneOf: - description: Static partner reward id nullable: true title: Static Value type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionScheduleUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/schedules/{actionId}` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionScheduleUpdateRequest' dates: $ref: '#/components/schemas/DatesInCampaignControllerActionScheduleUpdateRequest' delays: $ref: '#/components/schemas/DelaysInCampaignControllerActionScheduleUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionScheduleUpdateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionScheduleUpdateRequest' force: type: boolean quality: enum: - ALWAYS - HIGH - LOW type: string schedule_name: $ref: '#/components/schemas/ScheduleNameInCampaignControllerActionScheduleUpdateRequest' type: object BuiltCampaignControllerActionResponseBase: properties: action_id: type: string action_type: enum: - APPROVE - CANCEL_REWARD - CREATE_MEMBERSHIP - CREATIVE - DATA_INTELLIGENCE - DECLINE - DISPLAY - EARN_REWARD - EMAIL - EXPRESSION - FIRE_AS_PERSON - FULFILL_REWARD - INCENTIVIZE - INCENTIVIZE_STATUS_UPDATE - REDEEM_REWARD - REMOVE_MEMBERSHIP - REVOKE_REWARD - SCHEDULE - SHARE_EVENT - SIGNAL - SIGNAL_V1 - STEP_SIGNAL - WEBHOOK type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: type: boolean quality: enum: - ALWAYS - HIGH - LOW type: string type: object IncentivizeActionTypeInCampaignControllerActionIncentivizeCreateRequest: description: Choose between static or dynamic incentivize action type oneOf: - description: Static incentivize action type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{incentivizeActionType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('incentivizeActionType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ZoneNameInCampaignControllerActionEmailCreateRequest: description: Choose between static or dynamic zone name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static zone name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{zoneName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('zoneName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventNameInCampaignControllerActionDataIntelligenceResponse: description: 'The event name as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string SlotsInCampaignControllerActionEarnRewardCreateRequest: description: Choose between static or dynamic slots oneOf: - description: Static slots items: type: string title: Static Value type: array uniqueItems: true - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{slots}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('slots');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FileInputStreamRequest: properties: attributes: $ref: '#/components/schemas/FileAttributes' inputStream: type: object required: - attributes - inputStream type: object EnabledInCampaignControllerActionSignalCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTimeInCampaignControllerActionFulfillRewardCreateRequest: description: Choose between static or dynamic event time oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Static event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnabledInCampaignControllerActionFireAsPersonCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventNameInCampaignControllerActionDataIntelligenceRequest: description: Choose between static or dynamic event name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static event name title: Static Value - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{eventName}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('eventName');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInCampaignControllerActionCancelRewardUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string WebhookIdInCampaignControllerActionWebhookResponse: description: 'The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal webhook id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{webhookId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('webhookId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardSupplierIdInCampaignControllerActionEarnRewardResponse: description: 'The reward supplier id as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal reward supplier id title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardSupplierId}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('rewardSupplierId');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ZonedDateTime: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.' example: '2025-10-24T02:00:00-07:00' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string CampaignControllerActionIncentivizeUpdateRequest: description: Body of a `PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivizes/{actionId}` request. properties: action_name: nullable: true type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionIncentivizeUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionIncentivizeUpdateRequest' incentivize_action_type: $ref: '#/components/schemas/IncentivizeActionTypeInCampaignControllerActionIncentivizeUpdateRequest' overrides: additionalProperties: type: string type: object quality: enum: - ALWAYS - HIGH - LOW type: string review_status: $ref: '#/components/schemas/ReviewStatusInCampaignControllerActionIncentivizeUpdateRequest' type: object CampaignControllerActionWebhookCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/webhooks` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionWebhookCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionWebhookCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string webhook_id: $ref: '#/components/schemas/WebhookIdInCampaignControllerActionWebhookCreateRequest' type: object CampaignControllerActionCreateMembershipResponse: allOf: - $ref: '#/components/schemas/CampaignControllerActionResponseBase' - properties: action_type: enum: - CREATE_MEMBERSHIP type: string audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionCreateMembershipResponse' type: object type: object EnabledInCampaignControllerActionEmailCreateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EventTimeInCampaignControllerActionFulfillRewardResponse: description: 'The event time as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - allOf: - $ref: '#/components/schemas/Instant' description: Literal event time title: Static Value - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionEmailCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/emails` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionEmailCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionEmailCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string zone_name: $ref: '#/components/schemas/ZoneNameInCampaignControllerActionEmailCreateRequest' type: object BuiltCampaignControllerActionFireAsPersonResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - FIRE_AS_PERSON type: string as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' data: $ref: '#/components/schemas/DataMapInBuiltCampaignControllerActionFireAsPersonResponse' event_name: type: string event_time: $ref: '#/components/schemas/EventTimeInBuiltCampaignControllerActionFireAsPersonResponse' extra_data: $ref: '#/components/schemas/ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInBuiltCampaignControllerActionFireAsPersonResponse' type: object type: object DataMapInCampaignControllerActionEmailCreateRequest: additionalProperties: $ref: '#/components/schemas/DataInCampaignControllerActionEmailCreateRequest' type: object EnabledInCampaignControllerActionDisplayUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DelaysInCampaignControllerActionScheduleCreateRequest: description: Choose between static or dynamic delays oneOf: - description: Static delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{delays}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('delays');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionDataIntelligenceRequest: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionDataIntelligenceRequest' event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionDataIntelligenceRequest' intelligence_provider: $ref: '#/components/schemas/IntelligenceProviderInCampaignControllerActionDataIntelligenceRequest' profile_risk_update_interval: $ref: '#/components/schemas/ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse' type: object CampaignControllerActionExpressionCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/expressions` request. properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionExpressionCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionExpressionCreateRequest' expression: $ref: '#/components/schemas/ExpressionInCampaignControllerActionExpressionCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object DataInCampaignControllerActionEmailCreateRequest: description: Choose between static or dynamic data oneOf: - description: Static data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionFireAsPersonCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fire-as-person` request. properties: as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array data: $ref: '#/components/schemas/DataMapInCampaignControllerActionFireAsPersonCreateRequest' enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionFireAsPersonCreateRequest' event_name: $ref: '#/components/schemas/EventNameInCampaignControllerActionFireAsPersonCreateRequest' event_time: $ref: '#/components/schemas/EventTimeInCampaignControllerActionFireAsPersonCreateRequest' extra_data: $ref: '#/components/schemas/ExtraDataInCampaignControllerActionFireAsPersonCreateRequest' labels: items: type: string type: array uniqueItems: true person_id: $ref: '#/components/schemas/PersonIdInCampaignControllerActionFireAsPersonCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object PersonIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PERSON_ID type: string type: object DataInBuiltCampaignControllerActionIncentivizeResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInCampaignControllerActionEarnRewardCreateRequest: 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 [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{tags}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('tags');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string AmountInCampaignControllerActionFulfillRewardCreateRequest: description: Choose between static or dynamic amount oneOf: - description: Static amount nullable: true title: Static Value type: object - description: Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{amount}} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('amount');} externalDocs: description: RewardActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInCampaignControllerActionFireAsPersonResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DelaysInCampaignControllerActionScheduleUpdateRequest: description: Choose between static or dynamic delays oneOf: - description: Static delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{delays}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('delays');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The event type as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: 'The data as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal data title: Static Value type: object - description: Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string HeadersInCampaignControllerActionDisplayResponse: description: 'The headers as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - additionalProperties: type: string description: Literal headers title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{headers}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('headers');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CampaignControllerActionRemoveMembershipCreateRequest: description: Body of a `POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/remove-memberships` request. properties: audience_id: $ref: '#/components/schemas/AudienceIdInCampaignControllerActionRemoveMembershipCreateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array enabled: $ref: '#/components/schemas/EnabledInCampaignControllerActionRemoveMembershipCreateRequest' quality: enum: - ALWAYS - HIGH - LOW type: string type: object IncentivizeActionTypeInCampaignControllerActionIncentivizeUpdateRequest: description: Choose between static or dynamic incentivize action type oneOf: - description: Static incentivize action type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{incentivizeActionType}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('incentivizeActionType');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse: description: 'The profile risk update interval as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal profile risk update interval properties: nano: format: int32 type: integer negative: type: boolean positive: type: boolean seconds: format: int64 type: integer units: items: properties: dateBased: type: boolean duration: $ref: '#/components/schemas/Duration' durationEstimated: type: boolean timeBased: type: boolean type: object type: array zero: type: boolean title: Static Value type: object - description: Handlebars expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: handlebars@buildtime:{{profileRiskUpdateInterval}} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ControllerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('profileRiskUpdateInterval');} externalDocs: description: ControllerBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/ControllerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string examples: campaign_controller_action_revoke_reward_too_long_expression: summary: campaign_controller_action_revoke_reward_too_long_expression value: code: campaign_controller_action_revoke_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_identification_missing: summary: campaign_controller_action_fire_as_person_identification_missing value: code: campaign_controller_action_fire_as_person_identification_missing http_status_code: 400 message: Person identification is required. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_value_length_invalid: summary: data_value_length_invalid value: code: data_value_length_invalid http_status_code: 400 message: Data value can't be blank or longer than maximum length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 signal_polling_id_length_invalid: summary: signal_polling_id_length_invalid value: code: signal_polling_id_length_invalid http_status_code: 400 message: Signal polling id can't be blank or longer than maximum length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 circular_component_reference: summary: circular_component_reference value: code: circular_component_reference http_status_code: 400 message: Circular campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_facets_not_found: summary: component_facets_not_found value: code: component_facets_not_found http_status_code: 400 message: Component facets not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_controller_trigger_id: summary: invalid_controller_trigger_id value: code: invalid_controller_trigger_id http_status_code: 403 message: Invalid campaign controller trigger id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_name_invalid: summary: data_name_invalid value: code: data_name_invalid http_status_code: 400 message: Data name is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_length_invalid: summary: expression_length_invalid value: code: expression_length_invalid http_status_code: 400 message: The expression can't be blank or be longer than maximum length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_polling_name_length: summary: campaign_controller_action_approve_polling_name_length value: code: campaign_controller_action_approve_polling_name_length http_status_code: 400 message: 'Polling name expression too long. Max length: 2000' 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 controller_misconfiguration: summary: controller_misconfiguration value: code: controller_misconfiguration http_status_code: 400 message: A controller is not properly configured parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 campaign_controller_action_fire_as_person_identification_value_length_out_of_range: summary: campaign_controller_action_fire_as_person_identification_value_length_out_of_range value: code: campaign_controller_action_fire_as_person_identification_value_length_out_of_range http_status_code: 400 message: Person identification value is out of range. Maximum length is 2000 characters. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_redeem_reward_too_long_expression: summary: campaign_controller_action_redeem_reward_too_long_expression value: code: campaign_controller_action_redeem_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2000 characters 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 campaign_controller_action_signal_data_attribute_value_length_out_of_range: summary: campaign_controller_action_signal_data_attribute_value_length_out_of_range value: code: campaign_controller_action_signal_data_attribute_value_length_out_of_range http_status_code: 403 message: Data attribute value length is out of range. Max 2000 chars 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 campaign_controller_action_approve_polling_id_length: summary: campaign_controller_action_approve_polling_id_length value: code: campaign_controller_action_approve_polling_id_length http_status_code: 400 message: 'Polling id expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_cancel_reward_invalid_expression: summary: campaign_controller_action_cancel_reward_invalid_expression value: code: campaign_controller_action_cancel_reward_invalid_expression http_status_code: 400 message: Invalid SpEL expression parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_too_long_expression: summary: campaign_controller_action_earn_reward_too_long_expression value: code: campaign_controller_action_earn_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2048 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 webhook_not_found: summary: webhook_not_found value: code: webhook_not_found http_status_code: 400 message: Was unable to find webhook with id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_cancel_reward_empty_reward_id: summary: campaign_controller_action_cancel_reward_empty_reward_id value: code: campaign_controller_action_cancel_reward_empty_reward_id http_status_code: 400 message: Reward Id can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_step_signal_polling_id_invalid_length: summary: campaign_controller_action_step_signal_polling_id_invalid_length value: code: campaign_controller_action_step_signal_polling_id_invalid_length http_status_code: 400 message: Step signal polling id value length is out of range. Max 2000 chars 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_controller_action_redeem_reward_invalid_expression: summary: campaign_controller_action_redeem_reward_invalid_expression value: code: campaign_controller_action_redeem_reward_invalid_expression http_status_code: 400 message: Invalid SpEL expression parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_invalid_tags_length: summary: campaign_controller_action_earn_reward_invalid_tags_length value: code: campaign_controller_action_earn_reward_invalid_tags_length http_status_code: 400 message: Cumulative tags length can't be greater than 2048 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range: summary: campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range value: code: campaign_controller_action_fire_as_person_partner_event_key_length_out_of_range http_status_code: 400 message: Partner event key is out of range. Maximum length is 2000 characters. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_note_length: summary: campaign_controller_action_decline_note_length value: code: campaign_controller_action_decline_note_length http_status_code: 400 message: 'Note expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_invalid_locale: summary: creative_has_invalid_locale value: code: creative_has_invalid_locale http_status_code: 400 message: Creative archive has an invalid locale parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_tags: summary: campaign_controller_action_earn_reward_missing_tags value: code: campaign_controller_action_earn_reward_missing_tags http_status_code: 400 message: At least one tag should be provided parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_archive_size_too_big: summary: creative_archive_size_too_big value: code: creative_archive_size_too_big http_status_code: 400 message: Submitted archive is greater than max allowed size parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_unknown_classification: summary: creative_has_unknown_classification value: code: creative_has_unknown_classification http_status_code: 400 message: Unable to determine creative classification. Creative archive must contain one of the required render files parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 campaign_controller_action_signal_signal_polling_id_out_of_range: summary: campaign_controller_action_signal_signal_polling_id_out_of_range value: code: campaign_controller_action_signal_signal_polling_id_out_of_range http_status_code: 403 message: Signal polling id value length is out of range. Max 2000 chars parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_duplicate_data_entry_name: summary: campaign_controller_action_schedule_duplicate_data_entry_name value: code: campaign_controller_action_schedule_duplicate_data_entry_name http_status_code: 400 message: Two data entry names evaluated to the same value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_path_invalid: summary: creative_asset_file_path_invalid value: code: creative_asset_file_path_invalid http_status_code: 400 message: Asset file path is invalid (not an URI or contains invalid characters) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_event_type_length: summary: campaign_controller_action_approve_event_type_length value: code: campaign_controller_action_approve_event_type_length http_status_code: 400 message: 'Event type expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_incentivize_action_name_invalid_value: summary: campaign_controller_action_incentivize_action_name_invalid_value value: code: campaign_controller_action_incentivize_action_name_invalid_value http_status_code: 400 message: Incentivize action name can't be empty 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 javascript_error: summary: javascript_error value: code: javascript_error http_status_code: 400 message: Error with archive's javascript parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_default_locale_disabled: summary: creative_has_default_locale_disabled value: code: creative_has_default_locale_disabled http_status_code: 400 message: Default locale must be in the list of enabled locales parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_event_type_length: summary: campaign_controller_action_decline_event_type_length value: code: campaign_controller_action_decline_event_type_length http_status_code: 400 message: 'Event type expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_double_person_identification: summary: campaign_controller_action_fire_as_person_double_person_identification value: code: campaign_controller_action_fire_as_person_double_person_identification http_status_code: 400 message: Please provide just one form of person identification. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_creative_archive_error: summary: campaign_controller_action_creative_archive_error value: code: campaign_controller_action_creative_archive_error http_status_code: 403 message: Invalid creative archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_force_length: summary: campaign_controller_action_approve_force_length value: code: campaign_controller_action_approve_force_length http_status_code: 400 message: 'Force expression too long. Max length: 2000' 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 webhook_missing: summary: webhook_missing value: code: webhook_missing http_status_code: 400 message: Webhook is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_revoke_reward_undefined_expression: summary: campaign_controller_action_revoke_reward_undefined_expression value: code: campaign_controller_action_revoke_reward_undefined_expression http_status_code: 400 message: Expression can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_cancel_reward_too_long_expression: summary: campaign_controller_action_cancel_reward_too_long_expression value: code: campaign_controller_action_cancel_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2048 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_email_zone_name_out_of_range: summary: campaign_controller_action_email_zone_name_out_of_range value: code: campaign_controller_action_email_zone_name_out_of_range http_status_code: 400 message: Zone name length must be between 2 and 50 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_redeem_reward_data_attribute_value_invalid: summary: campaign_controller_action_redeem_reward_data_attribute_value_invalid value: code: campaign_controller_action_redeem_reward_data_attribute_value_invalid http_status_code: 400 message: Data attribute value is invalid, should not exceed 2000 characters 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 invalid_controller_action_id: summary: invalid_controller_action_id value: code: invalid_controller_action_id http_status_code: 403 message: Invalid campaign controller action id 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 reserved_name: summary: reserved_name value: code: reserved_name http_status_code: 400 message: Campaign frontend controller name is reserved parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_out_of_range: summary: campaign_component_display_name_out_of_range value: code: campaign_component_display_name_out_of_range http_status_code: 400 message: Campaign component display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_size_too_big: summary: creative_asset_file_size_too_big value: code: creative_asset_file_size_too_big http_status_code: 400 message: Asset file size is greater than max allowed size parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference_socket_name: summary: invalid_component_reference_socket_name value: code: invalid_component_reference_socket_name http_status_code: 400 message: Invalid component reference socket name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_backdated_date_not_allowed: summary: campaign_controller_action_schedule_backdated_date_not_allowed value: code: campaign_controller_action_schedule_backdated_date_not_allowed http_status_code: 400 message: Backdated dates are not allowed 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_controller_action_approve_note_length: summary: campaign_controller_action_approve_note_length value: code: campaign_controller_action_approve_note_length http_status_code: 400 message: 'Note expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fulfill_reward_undefined_expression: summary: campaign_controller_action_fulfill_reward_undefined_expression value: code: campaign_controller_action_fulfill_reward_undefined_expression http_status_code: 400 message: Expression can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_step_signal_polling_id_invalid_expression: summary: campaign_controller_action_step_signal_polling_id_invalid_expression value: code: campaign_controller_action_step_signal_polling_id_invalid_expression http_status_code: 400 message: Invalid polling id expression parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 name_length_invalid: summary: name_length_invalid value: code: name_length_invalid http_status_code: 400 message: Name can't be longer than maximum length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_redeem_reward_missing_reward_id: summary: campaign_controller_action_redeem_reward_missing_reward_id value: code: campaign_controller_action_redeem_reward_missing_reward_id http_status_code: 400 message: Reward Id can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_file_path_too_long: summary: creative_asset_file_path_too_long value: code: creative_asset_file_path_too_long http_status_code: 400 message: Asset file path length is greater than max allowed length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_email_zone_name_contains_illegal_character: summary: campaign_controller_action_email_zone_name_contains_illegal_character value: code: campaign_controller_action_email_zone_name_contains_illegal_character http_status_code: 400 message: Zone name can only contain alphanumeric and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_incentivize_action_name_invalid_expression: summary: campaign_controller_action_incentivize_action_name_invalid_expression value: code: campaign_controller_action_incentivize_action_name_invalid_expression http_status_code: 400 message: Incentivize action name is not a valid SpEL expression parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_invalid_tag: summary: campaign_controller_action_earn_reward_invalid_tag value: code: campaign_controller_action_earn_reward_invalid_tag http_status_code: 400 message: Tag can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_reward_supplier: summary: campaign_controller_action_earn_reward_missing_reward_supplier value: code: campaign_controller_action_earn_reward_missing_reward_supplier http_status_code: 400 message: Reward supplier is required on launched campaigns parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_incentivize_override_value_invalid: summary: campaign_controller_action_incentivize_override_value_invalid value: code: campaign_controller_action_incentivize_override_value_invalid http_status_code: 400 message: Override value is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fulfill_reward_too_long_expression: summary: campaign_controller_action_fulfill_reward_too_long_expression value: code: campaign_controller_action_fulfill_reward_too_long_expression http_status_code: 400 message: Expression should not exceed 2048 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_value_invalid: summary: data_value_invalid value: code: data_value_invalid http_status_code: 400 message: Data value is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_create_membership_audience_not_found: summary: campaign_controller_action_create_membership_audience_not_found value: code: campaign_controller_action_create_membership_audience_not_found http_status_code: 400 message: Was unable to find audience with id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_legacy_action_id_length: summary: campaign_controller_action_approve_legacy_action_id_length value: code: campaign_controller_action_approve_legacy_action_id_length http_status_code: 400 message: 'Legacy action id expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_data_entry_name_out_of_range: summary: campaign_controller_action_fire_as_person_data_entry_name_out_of_range value: code: campaign_controller_action_fire_as_person_data_entry_name_out_of_range http_status_code: 400 message: Data entry name cannot be blank or exceed the maximum allowed length of 200 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 download_error: summary: download_error value: code: download_error http_status_code: 400 message: An error occurred downloading the creative archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_event_name_length_out_of_range: summary: campaign_controller_action_fire_as_person_event_name_length_out_of_range value: code: campaign_controller_action_fire_as_person_event_name_length_out_of_range http_status_code: 400 message: Event name is not of valid length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_signal_data_attribute_name_length_out_of_range: summary: campaign_controller_action_signal_data_attribute_name_length_out_of_range value: code: campaign_controller_action_signal_data_attribute_name_length_out_of_range http_status_code: 403 message: Data attribute name length is out of range. Max 200 chars parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_redeem_reward_data_attribute_name_invalid: summary: campaign_controller_action_redeem_reward_data_attribute_name_invalid value: code: campaign_controller_action_redeem_reward_data_attribute_name_invalid http_status_code: 400 message: Data attribute name is invalid, should not exceed 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_incentivize_override_value_length_out_of_range: summary: campaign_controller_action_incentivize_override_value_length_out_of_range value: code: campaign_controller_action_incentivize_override_value_length_out_of_range http_status_code: 400 message: Override value length is out of range. Max 2000 chars parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_journey_field_invalid: summary: campaign_controller_action_fire_as_person_journey_field_invalid value: code: campaign_controller_action_fire_as_person_journey_field_invalid http_status_code: 400 message: A person journey field value is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_partner_event_key_missing: summary: campaign_controller_action_fire_as_person_partner_event_key_missing value: code: campaign_controller_action_fire_as_person_partner_event_key_missing http_status_code: 400 message: Partner event key is required. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_frontend_controller_duplicate_controller: summary: campaign_frontend_controller_duplicate_controller value: code: campaign_frontend_controller_duplicate_controller http_status_code: 400 message: Two frontend controllers have the same unique key (controller name, journey name) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_archive_id: summary: invalid_archive_id value: code: invalid_archive_id http_status_code: 400 message: Creative archive not found for campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_out_of_range: summary: campaign_component_name_out_of_range value: code: campaign_component_name_out_of_range http_status_code: 400 message: Campaign component name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference: summary: invalid_component_reference value: code: invalid_component_reference http_status_code: 400 message: Unknown referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_missing_schedule_name: summary: campaign_controller_action_schedule_missing_schedule_name value: code: campaign_controller_action_schedule_missing_schedule_name http_status_code: 400 message: Missing schedule name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_type_validation_failed: summary: campaign_component_type_validation_failed value: code: campaign_component_type_validation_failed http_status_code: 400 message: Campaign component type validation failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 data_name_length_invalid: summary: data_name_length_invalid value: code: data_name_length_invalid http_status_code: 400 message: Data name can't be blank or longer than maximum length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_invalid_delay: summary: campaign_controller_action_schedule_invalid_delay value: code: campaign_controller_action_schedule_invalid_delay http_status_code: 400 message: Schedule delays is null or contains a null delay parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_incentivize_action_name_invalid_length: summary: campaign_controller_action_incentivize_action_name_invalid_length value: code: campaign_controller_action_incentivize_action_name_invalid_length http_status_code: 400 message: Incentivize action name can't be greater that 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_identification_value_missing: summary: campaign_controller_action_fire_as_person_identification_value_missing value: code: campaign_controller_action_fire_as_person_identification_value_missing http_status_code: 400 message: Person identification value is required. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_step_signal_name_invalid_length: summary: campaign_controller_action_step_signal_name_invalid_length value: code: campaign_controller_action_step_signal_name_invalid_length http_status_code: 400 message: Step signal name value length invalid. Max 255 chars parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_journey_field_out_of_range: summary: campaign_controller_action_fire_as_person_journey_field_out_of_range value: code: campaign_controller_action_fire_as_person_journey_field_out_of_range http_status_code: 400 message: A person journey field value is out of range. Maximum length is 1000 characters. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 not_found_page_forbidden_runtime_expressions: summary: not_found_page_forbidden_runtime_expressions value: code: not_found_page_forbidden_runtime_expressions http_status_code: 400 message: Frontend controller for not found page shouldn't use runtime expressions in the action parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_asset_invalid_character_encoding: summary: creative_asset_invalid_character_encoding value: code: creative_asset_invalid_character_encoding http_status_code: 400 message: Asset file has invalid character encoding parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 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 campaign_controller_action_fire_as_person_journey_missing_referral_data: summary: campaign_controller_action_fire_as_person_journey_missing_referral_data value: code: campaign_controller_action_fire_as_person_journey_missing_referral_data http_status_code: 400 message: Journey data is missing for referral reason. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_cause_type_length: summary: campaign_controller_action_decline_cause_type_length value: code: campaign_controller_action_decline_cause_type_length http_status_code: 400 message: 'Cause type expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_partner_event_id_length: summary: campaign_controller_action_decline_partner_event_id_length value: code: campaign_controller_action_decline_partner_event_id_length http_status_code: 400 message: 'Partner event id expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_id_missing: summary: campaign_component_id_missing value: code: campaign_component_id_missing http_status_code: 400 message: Campaign component id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_undefined_expression: summary: campaign_controller_action_earn_reward_undefined_expression value: code: campaign_controller_action_earn_reward_undefined_expression http_status_code: 400 message: Expression can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_cause_type_length: summary: campaign_controller_action_approve_cause_type_length value: code: campaign_controller_action_approve_cause_type_length http_status_code: 400 message: 'Cause type expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_is_missing_renderer: summary: creative_is_missing_renderer value: code: creative_is_missing_renderer http_status_code: 400 message: Creative archive is missing one of the required renderer files parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_component_reference: summary: invalid_external_component_reference value: code: invalid_external_component_reference http_status_code: 400 message: Unknown external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_revoke_reward_invalid_expression: summary: campaign_controller_action_revoke_reward_invalid_expression value: code: campaign_controller_action_revoke_reward_invalid_expression http_status_code: 400 message: Invalid SpEL expression 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_controller_action_incentivize_action_type_missing: summary: campaign_controller_action_incentivize_action_type_missing value: code: campaign_controller_action_incentivize_action_type_missing http_status_code: 400 message: Incentivize action type is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_duplicate_data_entry_name: summary: campaign_controller_action_fire_as_person_duplicate_data_entry_name value: code: campaign_controller_action_fire_as_person_duplicate_data_entry_name http_status_code: 400 message: Two data entry names evaluated to the same value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_invalid_date: summary: campaign_controller_action_schedule_invalid_date value: code: campaign_controller_action_schedule_invalid_date http_status_code: 400 message: Invalid schedule date (must be date in ISO-8601 format) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 name_contains_illegal_character: summary: name_contains_illegal_character value: code: name_contains_illegal_character http_status_code: 400 message: Name should contain alphanumeric, underscore, dash, dot and space characters only parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_label_illegal_characters: summary: campaign_controller_action_fire_as_person_label_illegal_characters value: code: campaign_controller_action_fire_as_person_label_illegal_characters http_status_code: 400 message: Label contains illegal characters. Only lowercase alphabetic, numeric, underscore and dash characters are allowed. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_revoke_reward_missing_reward_id: summary: campaign_controller_action_revoke_reward_missing_reward_id value: code: campaign_controller_action_revoke_reward_missing_reward_id http_status_code: 400 message: Reward Id can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 not_found_page_invalid_action: summary: not_found_page_invalid_action value: code: not_found_page_invalid_action http_status_code: 400 message: Frontend controller for not found page must have only one action of display type with ALWAYS quality parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_journey_name_missing: summary: campaign_controller_action_fire_as_person_journey_name_missing value: code: campaign_controller_action_fire_as_person_journey_name_missing http_status_code: 400 message: Journey name is required. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fulfill_reward_empty_reward_id: summary: campaign_controller_action_fulfill_reward_empty_reward_id value: code: campaign_controller_action_fulfill_reward_empty_reward_id http_status_code: 400 message: Reward Id can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_elements_cannot_have_multiple_references: summary: external_elements_cannot_have_multiple_references value: code: external_elements_cannot_have_multiple_references http_status_code: 400 message: External elements cannot have multiple references parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_redeem_reward_undefined_expression: summary: campaign_controller_action_redeem_reward_undefined_expression value: code: campaign_controller_action_redeem_reward_undefined_expression http_status_code: 400 message: Expression can't be empty 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_controller_action_signal_data_attribute_name_invalid: summary: campaign_controller_action_signal_data_attribute_name_invalid value: code: campaign_controller_action_signal_data_attribute_name_invalid http_status_code: 403 message: Data attribute name is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_polling_id_length: summary: campaign_controller_action_decline_polling_id_length value: code: campaign_controller_action_decline_polling_id_length http_status_code: 400 message: 'Polling id expression too long. Max length: 2000' 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_controller_action_cancel_reward_undefined_expression: summary: campaign_controller_action_cancel_reward_undefined_expression value: code: campaign_controller_action_cancel_reward_undefined_expression http_status_code: 400 message: Expression can't be empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_negative_delay: summary: campaign_controller_action_schedule_negative_delay value: code: campaign_controller_action_schedule_negative_delay http_status_code: 400 message: Schedule delay must be positive number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_reward_name_too_long: summary: campaign_controller_action_earn_reward_reward_name_too_long value: code: campaign_controller_action_earn_reward_reward_name_too_long http_status_code: 400 message: Reward name should not exceed 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 creative_is_missing_attributes: summary: creative_is_missing_attributes value: code: creative_is_missing_attributes http_status_code: 400 message: Creative archive is missing required attributes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 redundant_component_reference: summary: redundant_component_reference value: code: redundant_component_reference http_status_code: 400 message: Same reference defined multiple times parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_data_entry_name_out_of_range: summary: campaign_controller_action_earn_reward_data_entry_name_out_of_range value: code: campaign_controller_action_earn_reward_data_entry_name_out_of_range http_status_code: 400 message: Data entry name cannot be blank or exceed the maximum allowed length of 200 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_remove_membership_audience_not_found: summary: campaign_controller_action_remove_membership_audience_not_found value: code: campaign_controller_action_remove_membership_audience_not_found http_status_code: 400 message: Was unable to find audience with id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_email_missing_zone_name: summary: campaign_controller_action_email_missing_zone_name value: code: campaign_controller_action_email_missing_zone_name http_status_code: 400 message: Missing zone name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_legacy_action_id_length: summary: campaign_controller_action_decline_legacy_action_id_length value: code: campaign_controller_action_decline_legacy_action_id_length http_status_code: 400 message: 'Legacy action id expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_event_name_contains_illegal_character: summary: campaign_controller_action_fire_as_person_event_name_contains_illegal_character value: code: campaign_controller_action_fire_as_person_event_name_contains_illegal_character http_status_code: 400 message: Event name should contain alphanumeric, underscore, dash, dot and space characters only parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 self_component_reference: summary: self_component_reference value: code: self_component_reference http_status_code: 400 message: Self campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_data_intelligence_event_invalid_event_name: summary: campaign_controller_action_data_intelligence_event_invalid_event_name value: code: campaign_controller_action_data_intelligence_event_invalid_event_name http_status_code: 400 message: Event name not valid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_reward_supplier_id_not_found: summary: campaign_controller_action_earn_reward_reward_supplier_id_not_found value: code: campaign_controller_action_earn_reward_reward_supplier_id_not_found http_status_code: 400 message: Reward supplier not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_data_intelligence_event_name_out_of_range: summary: campaign_controller_action_data_intelligence_event_name_out_of_range value: code: campaign_controller_action_data_intelligence_event_name_out_of_range http_status_code: 400 message: Event name length must be between 2 and 200 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_creative_missing_archive: summary: campaign_controller_action_creative_missing_archive value: code: campaign_controller_action_creative_missing_archive http_status_code: 400 message: Creative action does not have associated creative archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_mismatch_api_version: summary: creative_mismatch_api_version value: code: creative_mismatch_api_version http_status_code: 400 message: Creative mismatch api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_name_length_out_of_range: summary: controller_name_length_out_of_range value: code: controller_name_length_out_of_range http_status_code: 400 message: Campaign frontend controller name is not of valid length parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_approve_partner_event_id_length: summary: campaign_controller_action_approve_partner_event_id_length value: code: campaign_controller_action_approve_partner_event_id_length http_status_code: 400 message: 'Partner event id expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_name_out_of_range: summary: campaign_controller_action_schedule_name_out_of_range value: code: campaign_controller_action_schedule_name_out_of_range http_status_code: 400 message: Schedule name length must be between 2 and 100 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fire_as_person_missing_event_name: summary: campaign_controller_action_fire_as_person_missing_event_name value: code: campaign_controller_action_fire_as_person_missing_event_name http_status_code: 400 message: Event name is required. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_fulfill_reward_invalid_spel_expression: summary: campaign_controller_action_fulfill_reward_invalid_spel_expression value: code: campaign_controller_action_fulfill_reward_invalid_spel_expression http_status_code: 400 message: SPeL expression is not valid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 orphan_external_component_reference: summary: orphan_external_component_reference value: code: orphan_external_component_reference http_status_code: 400 message: Orphan external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_duplicate_data_entry_name: summary: campaign_controller_action_earn_reward_duplicate_data_entry_name value: code: campaign_controller_action_earn_reward_duplicate_data_entry_name http_status_code: 400 message: Two data entry names evaluated to the same value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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_controller_action_schedule_data_entry_name_out_of_range: summary: campaign_controller_action_schedule_data_entry_name_out_of_range value: code: campaign_controller_action_schedule_data_entry_name_out_of_range http_status_code: 400 message: Data entry name cannot be blank or exceed the maximum allowed length of 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_incompatible_api_version: summary: creative_has_incompatible_api_version value: code: creative_has_incompatible_api_version http_status_code: 400 message: Creative archive has an incompatible api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_contains_illegal_character: summary: campaign_component_name_contains_illegal_character value: code: campaign_component_name_contains_illegal_character http_status_code: 400 message: Campaign component name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 creative_has_invalid_api_version: summary: creative_has_invalid_api_version value: code: creative_has_invalid_api_version http_status_code: 400 message: Creative archive has an invalid api version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_is_referenced_by_active_configuration: summary: external_element_is_referenced_by_active_configuration value: code: external_element_is_referenced_by_active_configuration http_status_code: 400 message: External element is referenced by active configuration parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_decline_polling_name_length: summary: campaign_controller_action_decline_polling_name_length value: code: campaign_controller_action_decline_polling_name_length http_status_code: 400 message: 'Polling name expression too long. Max length: 2000' parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_schedule_delays_and_dates_not_supported_together: summary: campaign_controller_action_schedule_delays_and_dates_not_supported_together value: code: campaign_controller_action_schedule_delays_and_dates_not_supported_together http_status_code: 400 message: It is not allowed to configure both, date and delay and the same time parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 upload_error: summary: upload_error value: code: upload_error http_status_code: 400 message: Error uploading archive parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_controller_id: summary: invalid_campaign_controller_id value: code: invalid_campaign_controller_id http_status_code: 403 message: Invalid campaign controller id 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_controller_action_schedule_name_contains_illegal_character: summary: campaign_controller_action_schedule_name_contains_illegal_character value: code: campaign_controller_action_schedule_name_contains_illegal_character http_status_code: 400 message: Schedule name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_signal_data_attribute_value_invalid: summary: campaign_controller_action_signal_data_attribute_value_invalid value: code: campaign_controller_action_signal_data_attribute_value_invalid http_status_code: 403 message: Data attribute value is invalid 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_controller_action_fire_as_person_label_out_of_range: summary: campaign_controller_action_fire_as_person_label_out_of_range value: code: campaign_controller_action_fire_as_person_label_out_of_range http_status_code: 400 message: Label length is out of range. Allowed range is between 2 and 50. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_controller_action_earn_reward_missing_reward_name: summary: campaign_controller_action_earn_reward_missing_reward_name value: code: campaign_controller_action_earn_reward_missing_reward_name http_status_code: 400 message: Reward name is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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