ALalloy
Journeys

Update latest Journey Application by External Application ID

Changed on

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

Request

Headers

alloy-journey-override-syncboolean

This endpoint returns a synchronous response by default. If you would like to override this behavior and get an asynchronous response back immediately, send the header alloy-journey-override-sync as true.

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.

Example request

{
  "entities": [
    {
      "external_entity_id": "my_system_entity_id_123",
      "data": {
        "name_first": "John",
        "name_middle": "Franklin",
        "name_last": "Doe",
        "birth_date": "1990-01-25",
        "email_address": "john@alloy.com",
        "gender": "male",
        "ip_address_v4": "42.206.213.70",
        "addresses": [
          {
            "type": "primary",
            "line_1": "41 E. 11th",
            "line_2": "2nd floor",
            "city": "New York",
            "state": "NY",
            "country_code": "US"
          }
        ],
        "meta": {
          "user_type": "vip"
        }
      },
      "entity_type": "person",
      "branch_name": "my_person_branch_name",
      "entity_token": "P-1GoQALm40nPQSp7UVTJS"
    }
  ]
}

Response

Success

OR

Example response

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

Changes

  • 615aa97a5ddbRevision changes
    • breaking

      removed subschema #2: Updating data for an existing person entity subschema #3: Associating documents for an existing person entity from the / request property anyOf list

    • info

      added the new optional query request parameter fullData to all path's operations

    • info

      added the new optional header request parameter alloy-journey-override-sync

    • info

      added to the / request property anyOf list

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status