Journeys

Create Journey Application Batch

Changed on Nov 3, 2026

Create a batch of journey applications by passing in a list of entities, grouped into different applications by the multi_entity_application_batch_key that can be optionally supplied for each entity

post/journeys/{journey_token}/batches

Request

Base URL
https://sandbox.alloy.co/v1
Auth
- OAuth 2
  Client credentials
  Token URL/oauth/bearer
- or HTTP basic
TypeScript
https://skmtc.dev/alloy/apis/alloy-api/docs/journeys/:journey_token/batches/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

journey_tokenstring required

Example:J-VCQoADBJxeHtmdAvFqoS

Identifier of the journey

Headers

alloy-sandbox-use-webhooksboolean

Evaluation header

alloy-bypass-formatterboolean

Evaluation header

alloy-journey-versionnumber

Specifies the journey version to create an application from. This includes drafts and inactive versions. If not supplied, the active journey version will be used.

Example:1

Request body

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",
      "auto_decision_node_outcomes": {
        "Manual Review": "approved",
        "Authy": "approved",
        "23489243289": "denied"
      }
    }
  ]
}

Response

Success

journey_batch_status'pending' | 'complete' | 'failed' | 'pre_run'

Current status of batch

journey_batch_tokenstring

Unique identifier for newly created batch

errorstring

Changes

Nov 3, 2026615aa97a5ddb Revision changes
- breaking
  added to the / request property allOf list
- warning
  removed from the / request property allOf list
- info
  added the new optional header request parameter alloy-journey-version
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status

Operation history