curl --request POST \
  --url https://api.onesignal.com/apps/{app_id}/journeys \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "Welcome series",
  "description": "Onboard new users over their first week.",
  "audience": {
    "kind": "segment",
    "included_segment_ids": [
      "3f7c1e90-0000-0000-0000-000000000001"
    ],
    "excluded_segment_ids": []
  },
  "nodes": [
    {
      "kind": "send_push",
      "template_id": "9a8b7c6d-0000-0000-0000-000000000001"
    },
    {
      "kind": "wait",
      "duration_seconds": 86400
    },
    {
      "kind": "send_email",
      "template_id": "9a8b7c6d-0000-0000-0000-000000000002"
    }
  ]
}
'

import Onesignal from '@onesignal/node-onesignal';

const configuration = Onesignal.createConfiguration({
    restApiKey: 'YOUR_REST_API_KEY',
});
const apiInstance = new Onesignal.DefaultApi(configuration);

// string | Your OneSignal App ID in UUID v4 format.
const appId: string = "YOUR_APP_ID";
// CreateJourneyRequest
const createJourneyRequest: Onesignal.CreateJourneyRequest = {
    name: "name_example",
    description: "description_example",
    audience: {
      kind: "segment",
      included_segment_ids: [
        "included_segment_ids_example",
      ],
      excluded_segment_ids: [
        "excluded_segment_ids_example",
      ],
      future_additions_only: true,
      name: "name_example",
      attributes: [
        [
          {
            key: "key_example",
            operator: "equal",
            value: "value_example",
          },
        ],
      ],
    },
    early_exit: {
      rules: {
        on_segment: {
          included_segment_ids: [
            "included_segment_ids_example",
          ],
        },
        when_not_in_audience: true,
        on_session: true,
        on_event: {
          name: "name_example",
        },
      },
      tag_on_early_exit: {
        "key": "key_example",
      },
    },
    reentry_rules: {
      duration_seconds: 600,
    },
    schedule: {
      start_at: "start_at_example",
      stop_at: "stop_at_example",
      error: "error_example",
    },
    nodes: [
      {
        id: "id_example",
        kind: "wait",
        client_node_id: "client_node_id_example",
        annotation: "annotation_example",
        duration_seconds: 60,
        relative_to: "schedule_in_timezone",
        windows: [
          {
            start: null,
            end: null,
            day_of_week: 1,
          },
        ],
        time_zone: "time_zone_example",
        use_user_time_zone: true,
        template_id: "template_id_example",
        iam_id: "iam_id_example",
        user_ttl_seconds: 1,
        webhook_id: "webhook_id_example",
        assignments: {
          "key": "key_example",
        },
        randomize_on_entry: true,
        branches: [
          {
            id: "id_example",
            condition: {
              kind: "segment_membership",
              included_segment_ids: [
                "included_segment_ids_example",
              ],
              excluded_segment_ids: [
                "excluded_segment_ids_example",
              ],
              action: "received",
              sending_node_id: "sending_node_id_example",
              client_node_id: "client_node_id_example",
              name: "name_example",
              attributes: [
                [
                  {
                    key: "key_example",
                    operator: "equal",
                    value: "value_example",
                  },
                ],
              ],
              entry_event_match_attributes: [
                {},
              ],
            },
            weight: 3.14,
            nodes: [
              ,
            ],
          },
        ],
        expiration: {
          duration_seconds: 60,
          exits: true,
        },
      },
    ],
  };

try {
  const response = await apiInstance.createJourney(appId, createJourneyRequest);
  console.log(response);
} catch (e) {
  if (e instanceof Onesignal.ApiException) {
    // `e.errorMessages` flattens any error-envelope shape to a `string[]`;
    // the raw parsed body remains on `e.body`.
    console.error("createJourney failed: HTTP " + e.code, e.errorMessages);
  } else {
    throw e;
  }
}

import onesignal
from onesignal.api import default_api
from onesignal.models import *
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.
# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY.
# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself.
configuration = onesignal.Configuration(
    rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
    organization_api_key = "YOUR_ORGANIZATION_API_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)


# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    app_id = "YOUR_APP_ID" # Your OneSignal App ID in UUID v4 format. 
    create_journey_request = CreateJourneyRequest(
        name="name_example",
        description="description_example",
        audience=JourneyAudience(
            kind="segment",
            included_segment_ids=[
                "included_segment_ids_example",
            ],
            excluded_segment_ids=[
                "excluded_segment_ids_example",
            ],
            future_additions_only=True,
            name="name_example",
            attributes=JourneyEventTriggerAttributes([
                [
                    JourneyEventAttribute(
                        key="key_example",
                        operator="equal",
                        value="value_example",
                    ),
                ],
            ]),
        ),
        early_exit=JourneyEarlyExit(
            rules=JourneyEarlyExitRules(
                on_segment=JourneyEarlyExitRulesOnSegment(
                    included_segment_ids=[
                        "included_segment_ids_example",
                    ],
                ),
                when_not_in_audience=True,
                on_session=True,
                on_event=JourneyEarlyExitRulesOnEvent(
                    name="name_example",
                ),
            ),
            tag_on_early_exit={
                "key": "key_example",
            },
        ),
        reentry_rules=JourneyReentryRules(
            duration_seconds=600,
        ),
        schedule=JourneySchedule(
            start_at="start_at_example",
            stop_at="stop_at_example",
            error="error_example",
        ),
        nodes=[
            JourneyNode(
                id="id_example",
                kind="wait",
                client_node_id="client_node_id_example",
                annotation="annotation_example",
                duration_seconds=60,
                relative_to="schedule_in_timezone",
                windows=[
                    JourneyTimeWindow(
                        start=None,
                        end=None,
                        day_of_week=1,
                    ),
                ],
                time_zone="time_zone_example",
                use_user_time_zone=True,
                template_id="template_id_example",
                iam_id="iam_id_example",
                user_ttl_seconds=1,
                webhook_id="webhook_id_example",
                assignments={
                    "key": "key_example",
                },
                randomize_on_entry=True,
                branches=[
                    JourneyBranch(
                        id="id_example",
                        condition=JourneyCondition(
                            kind="segment_membership",
                            included_segment_ids=[
                                "included_segment_ids_example",
                            ],
                            excluded_segment_ids=[
                                "excluded_segment_ids_example",
                            ],
                            action="received",
                            sending_node_id="sending_node_id_example",
                            client_node_id="client_node_id_example",
                            name="name_example",
                            attributes=JourneyEventTriggerAttributes([
                                [
                                    JourneyEventAttribute(
                                        key="key_example",
                                        operator="equal",
                                        value="value_example",
                                    ),
                                ],
                            ]),
                            entry_event_match_attributes=[
                                {},
                            ],
                        ),
                        weight=3.14,
                        nodes=[
                            JourneyNode(),
                        ],
                    ),
                ],
                expiration=JourneyWaitUntilExpiration(
                    duration_seconds=60,
                    exits=True,
                ),
            ),
        ],
    ) 

    try:
        # Create journey
        api_response = api_instance.create_journey(app_id, create_journey_request)
        pprint(api_response)
    except onesignal.ApiException as e:
        print("Exception when calling DefaultApi->create_journey: %s\n" % e)
        print("Status Code: %s" % e.status)
        print("Response Body: %s" % e.body)

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: rest_api_key
$config = onesignal\client\Configuration::getDefaultConfiguration()
                                                ->setRestApiKeyToken('YOUR_REST_API_KEY')
                                                ->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');



$apiInstance = new onesignal\client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 'YOUR_APP_ID'; // string | Your OneSignal App ID in UUID v4 format.
$create_journey_request = new \onesignal\client\model\CreateJourneyRequest(); // \onesignal\client\model\CreateJourneyRequest

try {
    $result = $apiInstance->createJourney($app_id, $create_journey_request);
    print_r($result);
} catch (\onesignal\client\ApiException $e) {
    echo 'Exception when calling DefaultApi->createJourney: ', $e->getMessage(), PHP_EOL;
    echo 'Status Code: ', $e->getCode(), PHP_EOL;
    // getErrorMessages() flattens any error-envelope shape to a string[];
    // the raw body remains on getResponseBody().
    echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;
    echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;
} catch (\Exception $e) {
    echo 'Exception when calling DefaultApi->createJourney: ', $e->getMessage(), PHP_EOL;
}

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/OneSignal/onesignal-go-api/v5"
)

func main() {
    appId := "YOUR_APP_ID" // string | Your OneSignal App ID in UUID v4 format.
    createJourneyRequest := *onesignal.NewCreateJourneyRequest("Name_example") // CreateJourneyRequest | 

    configuration := onesignal.NewConfiguration()
    apiClient := onesignal.NewAPIClient(configuration)

    restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, "YOUR_REST_API_KEY") // App REST API key required for most endpoints

    resp, r, err := apiClient.DefaultApi.CreateJourney(restAuth, appId).CreateJourneyRequest(createJourneyRequest).Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.CreateJourney``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {
            // ErrorMessages() flattens any error-envelope shape to a []string;
            // the raw body remains on Body().
            fmt.Fprintf(os.Stderr, "Error Messages: %v\n", apiErr.ErrorMessages())
            fmt.Fprintf(os.Stderr, "Response Body: %s\n", apiErr.Body())
        }
    }
    // response from `CreateJourney`: Journey
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.CreateJourney`: %v\n", resp)
}

require 'onesignal'
# setup authorization
OneSignal.configure do |config|
  # Configure Bearer authorization: rest_api_key
  config.rest_api_key = 'YOUR_REST_API_KEY'

end

api_instance = OneSignal::DefaultApi.new
app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
create_journey_request = OneSignal::CreateJourneyRequest.new({name: 'name_example'}) # CreateJourneyRequest | 

begin
  # Create journey
  result = api_instance.create_journey(app_id, create_journey_request)
  p result
rescue OneSignal::ApiError => e
  puts "Error when calling DefaultApi->create_journey: #{e}"
  puts "Status Code: #{e.code}"
  # `e.error_messages` flattens any error-envelope shape to an Array<String>;
  # the raw body remains on `e.response_body`.
  puts "Error Messages: #{e.error_messages}"
  puts "Response Body: #{e.response_body}"
end

// Import classes:
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.model.*;
import com.onesignal.client.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.onesignal.com");
    
    // Configure HTTP bearer authorization: rest_api_key
    HttpBearerAuth rest_api_key = (HttpBearerAuth) defaultClient.getAuthentication("rest_api_key");
    rest_api_key.setBearerToken("YOUR_REST_API_KEY");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    String appId = "YOUR_APP_ID"; // String | Your OneSignal App ID in UUID v4 format.
    CreateJourneyRequest createJourneyRequest = new CreateJourneyRequest(); // CreateJourneyRequest | 
    try {
      Journey result = apiInstance.createJourney(appId, createJourneyRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#createJourney");
      System.err.println("Status code: " + e.getCode());
      // getErrorMessages() flattens any error-envelope shape to a List<String>;
      // the raw body remains on getResponseBody().
      System.err.println("Error messages: " + e.getErrorMessages());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

using System;
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;

namespace Example
{
    public class CreateJourneyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.onesignal.com";
            // Configure Bearer token for authorization: rest_api_key
            config.AccessToken = "YOUR_REST_API_KEY";

            var apiInstance = new DefaultApi(config);
            var appId = "YOUR_APP_ID";  // string | Your OneSignal App ID in UUID v4 format.
            var createJourneyRequest = new CreateJourneyRequest(); // CreateJourneyRequest | 

            try
            {
                // Create journey
                Journey result = apiInstance.CreateJourney(appId, createJourneyRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.CreateJourney: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                // e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList<string>;
                // the raw body remains on e.ErrorContent.
                Debug.Print("Error Messages: " + string.Join(", ", e.ErrorMessages));
                Debug.Print("Response Body: " + e.ErrorContent);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

use onesignal_rust_api::apis::configuration::Configuration;
use onesignal_rust_api::apis::default_api;

use onesignal_rust_api::models;


#[tokio::main]
async fn main() {
    let mut configuration = Configuration::new();
    configuration.rest_api_key_token = Some("YOUR_REST_API_KEY".to_string());


    // Realistic values are pulled from the spec's `example:` fields where present.
    let app_id: &str = "YOUR_APP_ID";
    let create_journey_request: models::CreateJourneyRequest = todo!();

    match default_api::create_journey(&configuration, app_id, create_journey_request).await {
        Ok(resp) => println!("{:?}", resp),
        Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {
            // `e.error_messages()` flattens any error-envelope shape to a Vec<String>;
            // the raw response remains on the ResponseError variant.
            eprintln!("create_journey failed: {:?}", e.error_messages());
        }
        Err(e) => eprintln!("create_journey failed: {:?}", e),
    }
}

{
  "id": "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
  "app_id": "1a2b3c4d-5e6f-7081-92a3-b4c5d6e7f809",
  "name": "Welcome series",
  "description": "Onboard new users over their first week.",
  "state": "draft",
  "created_at": "2026-06-01T14:00:00Z",
  "updated_at": "2026-06-01T14:00:00Z",
  "started_at": null,
  "archived_at": null,
  "created_source": "public_api",
  "audience": {
    "kind": "segment",
    "included_segment_ids": [
      "3f7c1e90-0000-0000-0000-000000000001"
    ],
    "excluded_segment_ids": [],
    "future_additions_only": false
  },
  "early_exit": null,
  "reentry_rules": null,
  "schedule": null,
  "nodes": [
    {
      "id": "11111111-0000-0000-0000-000000000001",
      "kind": "send_push",
      "template_id": "9a8b7c6d-0000-0000-0000-000000000001"
    },
    {
      "id": "11111111-0000-0000-0000-000000000002",
      "kind": "wait",
      "duration_seconds": 86400
    },
    {
      "id": "11111111-0000-0000-0000-000000000003",
      "kind": "send_email",
      "template_id": "9a8b7c6d-0000-0000-0000-000000000002"
    }
  ],
  "concurrency_key": "dcae4794fee16e450e448e37a6f8d0a5a7335755ff8cc76606e3d04b2f574e46"
}

{
  "errors": [
    {
      "code": "invalid-payload",
      "title": "did not contain a required property of 'name'",
      "meta": {
        "attribute": "base",
        "path": "name"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "journey-not-entitled",
      "title": "Journeys are not enabled for this app",
      "meta": {}
    }
  ]
}