--- title: "Rerun Journey Application" method: POST path: "/journeys/{journey_token}/applications/{journey_application_token}/rerun" tags: ["Journeys"] --- # Rerun Journey Application `POST /journeys/{journey_token}/applications/{journey_application_token}/rerun` ## Request - Base URL: `https://sandbox.alloy.co/v1` - URL: `https://sandbox.alloy.co/v1/journeys/{journey_token}/applications/{journey_application_token}/rerun` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `/oauth/bearer` - HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint re-runs an application that has already been run through Alloy. It will be run through the currently active version of the Journey, and will default to re-using the same payload as the original, but does allow for the user to optionally alter that original payload. The options for altering are the following: - Edit any of the payload information for any of the entities in the application by including, within an object in the `entities` array, the `entity_token` of the entity to be altered. Include any number of fields to be altered. Assign a value of null for any field you want to exclude. - Add any number of new entities to the application by including new entity objects in the payload. - Delete entire entities by putting these entity tokens to be deleted into an array called `exclude_entity_tokens` (at least one entity must remain). Any of the below headers used with the original application will also be used here. To change the value of the header, include the updated value with this request. ## Request body - JourneyApplicationRerunPayload - `external_application_id` string: Optional, allows to set a different external identifier for the new Application. If not supplied, the value will be copied from the original Application (null if none had originally been provided). Supported characters are: `a-zA-Z0-9_-` - `exclude_entity_tokens` EntityToken[]: List of entity tokens to be deleted - `entities` JourneyApplicationEntityCreate[]: List of entities to be processed in this Application. - `external_entity_id` string: The value used on client's own system to identify the entity. If an entity associated with the value passed in already exists, then the entity application processes for that entity. Otherwise, a new entity is created and associated with the value passed in. This parameter is optional, but strongly encouraged. - `data` object, required: Contains the fields for each input attribute of each workflow in the journey that is expected to be processed for the entity. - `name_first` string - `name_middle` string - `name_last` string - `birth_date` string - `document_ssn` string: Social Security number. - `document_national_id` string: National ID number for a non-US person entity. - `document_id_card` string: ID card number - `document_license` string: U.S. issued driver's license number - `document_passport` string: Passport number - `email_address` string - `gender` string - `phone_number` string - `ip_address_v4` string - `addresses` JourneyAddressPayload[]: List of addresses for the given entity. - `type` string: Allowed values are `"primary"`, `"secondary"`, `"previous"`, `"mailing"`, `"shipping"`, `"service"`, `"other"` - `line_1` string - `line_2` string - `city` string - `state` string - `postal_code` string - `country_code` string - `meta` object: Any additional metadata to be accessed for decisioning or review purposes that are not sent to a data service can be referenced here. - `entity_type` 'person' | 'business': If left blank, defaults to `"person"`. - `branch_name` string: This value is required for journeys with multiple branches. It must match a journey branch configured from the start node. It is used to determine which steps the entity will be required to complete. - `entity_token` string: The token associated with an existing entity. By passing a value for this field, the entity application processes for the existing entity associated with the token. - `application_meta` object: Optional, allows to provide additional metadata applied to all entities in the Application. If not supplied, the value will be copied from the original Application (null if none had originally been provided). ## Response `201` Success - union - object - `journey_application_token` string - `status` 'completed' | 'data_request' | 'error' | 'expired' | 'pending_action' | 'pending_additional_entities' | 'pending_documents' | 'pending_journey_application_review' | 'pending_reconciliation' | 'pending_step_up' | 'pending_workflow_service' | 'running' | 'waiting_review' - `sandbox` boolean - `created_at` integer - `updated_at` integer - `closed_at` integer - `complete_outcome` string - `recent_outcome` string: Deprecated field - `is_shadow_app` boolean: indicates if the application was generated for a shadow test. This value is false for the parent applications that trigger the generation of the shadow applications. - `is_part_of_shadow_test` boolean: indicates if the application is a part of a shadow test. This value is true for both the parent applications that trigger the generation of the shadow applications, as well as the shadow applications. - `journey_application_status` string: derived from the `status` and `complete_outcome`, this value represents a simplified display status, as seen on the Journey Application Queue and Journey Application pages. - `is_archived` boolean - `external_group_id` string - `external_application_id` string: allows to associate one or multiple Journey Applications with an external identifier - `is_rerun` boolean - `archived_at` string - `terminal_reconciliation_output` OutputAttributeResponse - `outcome_reasons` object[] - `name` string - `type` 'adverse_action' | 'null', nullable - `tags` string[] - `output_attributes` object - `matrix_models` object - `application_meta` object: Optional, allows to provide additional metadata applied to all entities in the Application. - `_embedded` object - `rerun` object: The journey application that this is a rerun of - `initiated_by` 'api' | 'dashboard' - `previous_journey_application_token` string - `root_external_group_id` string - `root_journey_application_token` string - `reruns` object[]: The journey applications that are rerun versions of this application - `initiated_by` 'dashboard' | 'api' - `next_journey_application_token` string - `created_at` integer - `events` object[]: List of journey application events, ordered chronologically. The fields displayed in the event will depend on the event type - `journey_application_event_token` string - `journey_application_token` string - `journey_type` 'alert' | 'application' - `type` 'application_archived' | 'application_expired' | 'application_unarchived' | 'completed_action' | 'completed_application' | 'completed_branch' | 'completed_evaluation' | 'completed_mid_journey_reconciliation' | 'completed_reconciliation' | 'completed_review' | 'completed_review_journey_application' | 'data_request_evaluation' | 'error' | 'executed_branch_change' | 'has_finished_sending_additional_entities' | 'journey_application_retriggered' | 'maximum_retries_reached' | 'pending_action' | 'pending_action_expired' | 'pending_documents' | 'pending_evaluation' | 'pending_review' | 'pending_step_up' | 'pending_step_up_expired' | 'pending_workflow_service' | 'queued_branch_change' | 'reached_application_outcome' | 'reached_auto_decision_node' | 'reached_mid_journey_reconciliation_node' | 'reached_retry_node' | 'started_application' | 'started_evaluation' | 'started_mid_journey_reconciliation' | 'started_reconciliation' | 'started_rerun_application' | 'started_review' | 'visited_node' - `external_partner_id` string - `external_product_id` string - `external_group_id` string - `reason` string - `reasons` string[] - `timestamp` integer - `outcome` string: Populated for the following event types: `completed_action`, `completed_application`, `completed_branch`, `completed_evaluation`, `completed_review`, `pending_action_expired` - `evaluation_token` string: Identifying evaluation token (only in evaluation type events) - `entity_token` string - `entity_application_token` string - `error_data` object: Additional error data populated when available for `error` event types - `error` object - `type` string - `details` object - `message` string - `minor_code` integer - `error_token` string - `timestamp` integer - `status_code` integer - `entity_token` string - `evaluation_token` string - `application_token` string - `application_version_id` integer - `_embedded` object - `node` object - `name` string - `id` string - `type` 'action' | 'docv' | 'outcome' | 'reconciliation_workflow' | 'review' | 'step_up' | 'workflow' - `config` object: Config related to the specific node, depending on the type - `workflow_name` string - `sdk_config` object: Settings to be read by SDK to handle processing. Only present on workflow node events. - … - `_links` object - `evaluation` object - `href` string - `case` object - `href` string - `journey` object - `journey_name` string - `journey_type` 'application' | 'alert' - `journey_token` string - `journey_version_num` string - `_links` object - `self` object - `href` string: GET route for the Journey - `callback_by_entity_application_token` object: When applicable, the route to send a PUT request to for each entity application to resolve its current pending state - `child_entities` object[] - `external_entity_identifier` string - `name` string - `token` string - `type` string - `entity_application_token` string - `entity_application_status` string - `entity_application_outcome` string - `entity_application_branch_name` string - `created` string - `sandbox_persona_name` string: When applicable, name of sandbox persona used for this child entity - `external_entity_ids` object[]: All external entity ids associated with the child entity - `external_entity_id` string - `external_entity_id_type` string, nullable - `entity_applications` object[] - `entity_token` string - `entity_application_token` string - `entity_application_outcome` string - `entity_application_status` string - `sdk_link` string - `external_entity_identifiers` object[]: All external entity ids associated with the entity application's entity - `external_entity_identifier` string - `external_entity_identifier_type` string, nullable - `dimensions` object[]: The dimension(s) that triggered this entity application. This is only applicable when the application was created by a portfolio evaluation. - `dimension` string - `dimension_type` string - `entity_application_status_details` object: Additional details for applications that have status `data_request` or `pending_workflow_service`. * If the status is `data_request`, the `required`, `or`, and `optional` fields will be populated based on the journey configuration. * If the status is `pending_workflow_service`, the fields will be dependent on the services configured for the journey. Please speak to your representative for more information. - `required` object[] - `key` string - `type` string - `regex` string - `message` string - `description` string - `or` string - `optional` object[] - `key` string - `type` string - `regex` string - `description` string - `output` OutputAttributeResponse - `outcome_reasons` object[] - `name` string - `type` 'adverse_action' | 'null', nullable - `tags` string[] - `output_attributes` object - `matrix_models` object - `entity` object: The journey application entity - `external_entity_identifier` string - `name` string - `token` string - `type` string - `entity_group` object: The entity group associated with the application - `name` string - `token` string - `type` 'business' | 'joint_account' | 'membership' | 'merchant' - `multi_environment_config` MultiEnvironmentConfig - `multi_environment_config_token` string - `multi_environment_config_notes` string - `created_at` string - `journey_token` string - `journey_name` string - `journey_public_version` number - `actions` object[]: List of journey actions that have been configured as part of this Multi-Environment Configuration. - `journey_action_id` number - `action_version` number - `action_name` string - `outcome` string: The outcome that all action nodes for this journey action will be decisioned to. - `workflows` object[]: List of workflows that have been configured as part of this Multi-Environment Configuration. Workflows will either have an outcome or a list of configured services. - `workflow_name` string - `workflow_node_type` string: The type of node this workflow is used as, for example Step Up - `workflow_token` string - `workflow_public_version` number - `outcome` string: The outcome that all workflow nodes using this workflow will be decisioned to. - `configured_services` object[] - `service_name` string - `has_credentials` boolean: True if this service has been configured with test credentials, false otherwise. - `sandbox` boolean: True if this service has been configured to run in Alloy's sandbox environment, false otherwise. - `credentials_description` string - `is_pending_additional_entities` boolean: If this value is true, additional entities can be sent by using the PUT endpoint that updates a Journey Application. The Journey Application will not complete until the parameter `has_finished_sending_additional_entities` is sent with the value `true` to the PUT endpoint. - `investigations` object[]: When applicable, the list of Investigations created by this Alert. - `investigation_token` string - `investigation_state` 'alert_review' | 'alert_review_closed' | 'case_review' | 'case_review_closed' | 'open' - `_links` object - `self` object - `href` string: GET route for the Application - object - `journey_application_token` string - `_links` object - `self` object - `href` string: GET route for the Application ## Other responses - `400`: Request Body Failure - `401`: Authentication Failure - `404`: Not Found - `429`: Rate Limit Exceeded - `500`: Unhandled Service Error - `503`: Temporarily Offline for Maintenance ## Changes - **2026-11-03** `615aa97a5ddb`: 15 info - added the new optional `header` request parameter `alloy-refresh-cache` to all path's operations - added the new optional `header` request parameter `alloy-sandbox` to all path's operations - added the new optional `header` request parameter `alloy-sandbox-services` to all path's operations - added the new optional `query` request parameter `fullData` to all path's operations - …11 more [Operation history](https://skmtc.dev/alloy/apis/alloy-api/changes/journeys/:journey_token/applications/:journey_application_token/rerun/post.md) --- [API](https://skmtc.dev/alloy/apis/alloy-api.md) - [All operations](https://skmtc.dev/alloy/apis/alloy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alloy/apis/alloy-api/revisions/615aa97a5ddb?raw)