Sign in
latestOpenAPI 3.0.02026-07-241220330.3 KB

405799de4d2a

Journeys

Update latest Journey Application by External Application ID

This endpoint allows you to update the latest (i.e. most recently created) Application associated with the supplied External Application ID. If the journeyToken query parameter is provided, the retrieved Application will be the latest Application associated with that particular Journey and the External Application ID. The use cases for the endpoint are elaborated in the regular "Update Journey Application" endpoint.

put/journeys/applications/ext/{external_application_id}/latest

Parameters

#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/1 — unresolved $ref

Request body

has_finished_sending_additional_entitiesboolean

If the parameter do_await_additional_entities was set to true in the POST request to create the journey application, sending this value as true informs the system that all additional entities have been sent in.

entitiesItems[] — unresolved $ref

List of entities that can refer either of the following, or a mix of both:

  • Option 1: Adding new entities
    • This option is valid in the case where the parameter do_await_additional_entities was set to true in the POST request to create the journey application.
    • The parameters for this option are exactly the same as the entity object in the POST request to create the journey application.
  • Option 2: Updating data for an existing person entity
    • This option is valid in the case where the entity's application status is data_request.
    • For multi-entity applications, the entity application must be identified by using at least one of the following parameters: external_entity_id, entity_application_token, or entity_token. See those parameters' descriptions for more detail.
    • For single entity applications, no entity identifier is necessary.
    • The data in the field data is recursively merged with the existing data object for the entity (i.e., the data passed in the POST request and the previous requests to this endpoint, if any).
  • Option 3: Associating documents for an existing person entity
    • This option is valid in the case where the entity's application status is pending_step_up or pending_documents (legacy).

Response

Success

journey_application_tokenstring

Example response

{
  "journey_application_token": "JA-LS0GHKjDNhY6dGlvYxx",
  "_links": {
    "self": {
      "href": "/v1/journeys/J-Kq8jlFcA4veeHCtt823h/applications/JA-LS0GHKjDNhY6dGlvYxxH"
    }
  }
}