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";
// string | UUID of the journey that owns the node.
const journeyId: string = "YOUR_JOURNEY_ID";
// string | Server-assigned UUID of the node to update, from a prior View journey fetch.
const nodeId: string = "YOUR_NODE_ID";
// UpdateJourneyNodeRequest
const updateJourneyNodeRequest: Onesignal.UpdateJourneyNodeRequest = {};
try {
const response = await apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
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("updateJourneyNode 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.
journey_id = "YOUR_JOURNEY_ID" # UUID of the journey that owns the node.
node_id = "YOUR_NODE_ID" # Server-assigned UUID of the node to update, from a prior View journey fetch.
update_journey_node_request = UpdateJourneyNodeRequest()
try:
# Update journey node
api_response = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->update_journey_node: %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.
$journey_id = 'YOUR_JOURNEY_ID'; // string | UUID of the journey that owns the node.
$node_id = 'YOUR_NODE_ID'; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
$update_journey_node_request = new \onesignal\client\model\UpdateJourneyNodeRequest(); // \onesignal\client\model\UpdateJourneyNodeRequest
try {
$result = $apiInstance->updateJourneyNode($app_id, $journey_id, $node_id, $update_journey_node_request);
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->updateJourneyNode: ', $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->updateJourneyNode: ', $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.
journeyId := "YOUR_JOURNEY_ID" // string | UUID of the journey that owns the node.
nodeId := "YOUR_NODE_ID" // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
updateJourneyNodeRequest := *onesignal.NewUpdateJourneyNodeRequest() // UpdateJourneyNodeRequest |
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.UpdateJourneyNode(restAuth, appId, journeyId, nodeId).UpdateJourneyNodeRequest(updateJourneyNodeRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpdateJourneyNode``: %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 `UpdateJourneyNode`: Journey
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.UpdateJourneyNode`: %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.
journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey that owns the node.
node_id = 'YOUR_NODE_ID' # String | Server-assigned UUID of the node to update, from a prior View journey fetch.
update_journey_node_request = OneSignal::UpdateJourneyNodeRequest.new # UpdateJourneyNodeRequest |
begin
# Update journey node
result = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->update_journey_node: #{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 java.util.Arrays;
import java.util.List;
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.
String journeyId = "YOUR_JOURNEY_ID"; // String | UUID of the journey that owns the node.
String nodeId = "YOUR_NODE_ID"; // String | Server-assigned UUID of the node to update, from a prior View journey fetch.
UpdateJourneyNodeRequest updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest |
try {
Journey result = apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#updateJourneyNode");
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 UpdateJourneyNodeExample
{
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 journeyId = "YOUR_JOURNEY_ID"; // string | UUID of the journey that owns the node.
var nodeId = "YOUR_NODE_ID"; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
var updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest |
try
{
// Update journey node
Journey result = apiInstance.UpdateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateJourneyNode: " + 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 journey_id: &str = "YOUR_JOURNEY_ID";
let node_id: &str = "YOUR_NODE_ID";
let update_journey_node_request: models::UpdateJourneyNodeRequest = models::UpdateJourneyNodeRequest::new();
match default_api::update_journey_node(&configuration, app_id, journey_id, node_id, update_journey_node_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!("update_journey_node failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("update_journey_node failed: {:?}", e),
}
}
{
"errors": [
{
"code": "invalid-payload",
"title": "the property '#/nodes/1/bogus' is not defined and the schema does not allow additional properties",
"meta": {
"attribute": "base"
}
}
]
}
{
"errors": [
{
"code": "journey-not-entitled",
"title": "Journeys are not enabled for this app",
"meta": {}
}
]
}
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";
// string | UUID of the journey that owns the node.
const journeyId: string = "YOUR_JOURNEY_ID";
// string | Server-assigned UUID of the node to update, from a prior View journey fetch.
const nodeId: string = "YOUR_NODE_ID";
// UpdateJourneyNodeRequest
const updateJourneyNodeRequest: Onesignal.UpdateJourneyNodeRequest = {};
try {
const response = await apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
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("updateJourneyNode 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.
journey_id = "YOUR_JOURNEY_ID" # UUID of the journey that owns the node.
node_id = "YOUR_NODE_ID" # Server-assigned UUID of the node to update, from a prior View journey fetch.
update_journey_node_request = UpdateJourneyNodeRequest()
try:
# Update journey node
api_response = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->update_journey_node: %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.
$journey_id = 'YOUR_JOURNEY_ID'; // string | UUID of the journey that owns the node.
$node_id = 'YOUR_NODE_ID'; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
$update_journey_node_request = new \onesignal\client\model\UpdateJourneyNodeRequest(); // \onesignal\client\model\UpdateJourneyNodeRequest
try {
$result = $apiInstance->updateJourneyNode($app_id, $journey_id, $node_id, $update_journey_node_request);
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->updateJourneyNode: ', $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->updateJourneyNode: ', $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.
journeyId := "YOUR_JOURNEY_ID" // string | UUID of the journey that owns the node.
nodeId := "YOUR_NODE_ID" // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
updateJourneyNodeRequest := *onesignal.NewUpdateJourneyNodeRequest() // UpdateJourneyNodeRequest |
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.UpdateJourneyNode(restAuth, appId, journeyId, nodeId).UpdateJourneyNodeRequest(updateJourneyNodeRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpdateJourneyNode``: %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 `UpdateJourneyNode`: Journey
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.UpdateJourneyNode`: %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.
journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey that owns the node.
node_id = 'YOUR_NODE_ID' # String | Server-assigned UUID of the node to update, from a prior View journey fetch.
update_journey_node_request = OneSignal::UpdateJourneyNodeRequest.new # UpdateJourneyNodeRequest |
begin
# Update journey node
result = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->update_journey_node: #{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 java.util.Arrays;
import java.util.List;
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.
String journeyId = "YOUR_JOURNEY_ID"; // String | UUID of the journey that owns the node.
String nodeId = "YOUR_NODE_ID"; // String | Server-assigned UUID of the node to update, from a prior View journey fetch.
UpdateJourneyNodeRequest updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest |
try {
Journey result = apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#updateJourneyNode");
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 UpdateJourneyNodeExample
{
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 journeyId = "YOUR_JOURNEY_ID"; // string | UUID of the journey that owns the node.
var nodeId = "YOUR_NODE_ID"; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.
var updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest |
try
{
// Update journey node
Journey result = apiInstance.UpdateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateJourneyNode: " + 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 journey_id: &str = "YOUR_JOURNEY_ID";
let node_id: &str = "YOUR_NODE_ID";
let update_journey_node_request: models::UpdateJourneyNodeRequest = models::UpdateJourneyNodeRequest::new();
match default_api::update_journey_node(&configuration, app_id, journey_id, node_id, update_journey_node_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!("update_journey_node failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("update_journey_node failed: {:?}", e),
}
}
{
"errors": [
{
"code": "invalid-payload",
"title": "the property '#/nodes/1/bogus' is not defined and the schema does not allow additional properties",
"meta": {
"attribute": "base"
}
}
]
}
{
"errors": [
{
"code": "journey-not-entitled",
"title": "Journeys are not enabled for this app",
"meta": {}
}
]
}
Update a single node within an existing Journey. The request is a JSON Merge Patch (RFC 7396): send only the node fields you want to change, and the rest of the node, along with the rest of the journey graph, is left unchanged.
Prefer this endpoint over Update journey when you only need to change one node. The journey-level PATCH replaces the entire nodes array wholesale, so it requires re-sending every node with its id. This endpoint touches just the addressed node and preserves in-flight users on the others.
Authenticate with your App API Key. The authenticated key must have permission to update journeys. Find the journey id and the node id from a prior View journey fetch.Send only the fields to change. Node fields follow the same schema and validation as Create journey. For example, to shorten a wait node’s delay:
The request body is merged onto the addressed node:
A field you send replaces the current value. Omitted fields are untouched.
A null value clears a nullable field. Send "expiration": null on a wait_until node to wait indefinitely.
Arrays are replaced as a unit.branches and windows are not merged element-wise. Send the full array you want.
A node’s kind and its server-assigned id cannot be changed. A node keeps its kind for the life of its id, so changing the kind is rejected (send_push, send_email, and send_sms count as different kinds).
To avoid overwriting a concurrent change, pass the concurrency_key returned by a prior View journey fetch. If the journey has changed since that fetch, the request is rejected with 409 journey-stale and nothing is written. Omit concurrency_key to skip the check.The key covers the whole journey, not just the addressed node, so a concurrent edit to any part of the journey rejects the request. concurrency_key is not merged onto the node.
Treat concurrency_key as an opaque token: read it from the journey you are editing and send it back unchanged. Do not construct, parse, or compare it yourself.
The same active-journey rules as Update journey apply. An edit that would strand in-flight users (for example, changing a branching node’s branches) returns 400 with a field-level error.
A successful request returns 200 OK with the full updated journey, including server-assigned id fields and a concurrency_key. Pass that concurrency_key unchanged on a later update to avoid overwriting a concurrent change.
The request failed validation. This covers schema failures and business-logic failures such as editing a structural node on an active journey.
403
journey-not-entitled
Journeys are not enabled for this app.
404
journey-not-found
No journey with that id exists for this app.
404
journey-node-not-found
No node with that node_id exists in the journey.
409
journey-stale
The supplied concurrency_key no longer matches the journey; it changed since it was last fetched.
422
journey-archived
Archived journeys cannot be edited.
429
Rate limit exceeded. Wait the number of seconds in the Retry-After header before retrying. See Rate limits.
Coded errors use the shape { "errors": [{ "code", "title", "meta" }] }. For validation errors the failing field is in meta.attribute. Schema failures on this endpoint are reported against the merged journey, so the offending property is identified in the message by its position in the full graph, such as #/nodes/1/bogus.
Optional optimistic-concurrency token. Pass the concurrency_key from a prior fetch to reject the update with 409 if the journey changed in the meantime. Omit to skip the check. It is not merged onto the node.
Response
200
Full journey representation returned by the detail and create endpoints.
Journey state. Read-only. New journeys are created as draft. processing is a transient state while an activation is in progress, and archived is a journey that has been stopped. Change it through the state field on Update journey.
ISO 8601 time the journey was activated, or null. Read-only. May stay null briefly after you set state to active: activation is enqueued for processing, and started_at populates once the journey finishes processing and becomes active.
Conditions that remove a user from the journey before it completes. At least one rule must be set under rules; an early_exit that configures no rule is rejected. Send null to remove early exit entirely, or null for an individual rule to drop just that rule.
Opaque optimistic-concurrency token. Read-only. Pass it back on update to guard against overwriting a concurrent change (409 journey-stale). Send it back exactly as read from this response; do not construct or parse it.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OneSignal","description":"OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard.","colors":{"primary":"#3A3DB3","light":"#E54B4D","dark":"#3A3DB3"},"logo":{"light":"https://mintcdn.com/onesignal/yJcueeDCO7UpHnnY/logo/OneSignal-Logo.svg?fit=max\u0026auto=format\u0026n=yJcueeDCO7UpHnnY\u0026q=85\u0026s=1fcfb6fef6d820fd9d99c74850711107","dark":"https://mintcdn.com/onesignal/s4WC_KzLxf8ornqq/logo/OneSignal-Logo-White.svg?fit=max\u0026auto=format\u0026n=s4WC_KzLxf8ornqq\u0026q=85\u0026s=2573a53b5aea961e18c82b3af8f31925"},"favicon":"https://mintcdn.com/onesignal/SGduBFHpiRdg5l6h/favicon.ico?fit=max\u0026auto=format\u0026n=SGduBFHpiRdg5l6h\u0026q=85\u0026s=c0a99fadc0553c658a83741c5611cef4","api":{"examples":{"languages":["curl","typescript","python","php","go","ruby","java","csharp","rust"],"autogenerate":true}},"navbar":{"links":[{"href":"mailto:support@onesignal.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.onesignal.com"}},"footer":{"socials":{"github":"https://github.com/OneSignal","linkedin":"https://linkedin.com/company/onesignal","youtube":"https://www.youtube.com/@onesignalofficial/playlists"}},"seo":{"metatags":{"apple-mobile-web-app-title":"OneSignal Docs"}},"fonts":{"family":"Nunito Sans"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"ga4":{"measurementId":"G-2DGWL0VYP5"},"posthog":{"apiKey":"phc_vZpvE0f5eyzcOt30FHer34yddVmNdo9kmlMVRBzLMtn","apiHost":"https://eu.i.posthog.com","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"languages":[{"language":"en","href":"docs/en/home"},{"language":"cn","href":"docs/cn/home"},{"language":"ko","href":"docs/ko/home"},{"language":"ja","href":"docs/ja/home"},{"language":"tr","href":"docs/tr/home"},{"language":"pt-BR","href":"docs/pt-BR/home"},{"language":"es","href":"docs/es/home"},{"language":"fr","href":"docs/fr/home"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onesignal","hasAudioNarration":false,"actualSubdomain":"onesignal","customDomains":["documentation.onesignal.com"],"gitSource":{"type":"github","owner":"onesignal","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebb1cc40574e0e146e06f5","collectionId":"7de601f2-2191-44e0-a201-86d097330b1f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebb1cc40574e0e146e06f5"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebb1cc40574e0e146e06f5","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"en","tag":"User Guides","count":202},{"language":"es","tag":"Guías del Usuario","count":178},{"language":"fr","tag":"Guides utilisateur","count":178},{"language":"ja","tag":"ユーザーガイド","count":178},{"language":"ko","tag":"사용자 가이드","count":178},{"language":"pt-BR","tag":"Guia do Usuário","count":178},{"language":"tr","tag":"Kullanıcı Kılavuzları","count":178},{"language":"cn","tag":"用户指南","count":176},{"language":"en","tag":"Message channels","count":90},{"language":"es","tag":"Canales de mensajería","count":84},{"language":"fr","tag":"Canaux de messagerie","count":84},{"language":"ja","tag":"メッセージングチャネル","count":84},{"language":"ko","tag":"메시지 채널","count":84},{"language":"pt-BR","tag":"Canais de mensagem","count":84},{"language":"tr","tag":"Mesaj kanalları","count":84},{"language":"cn","tag":"消息渠道","count":83},{"language":"default","tag":"API Reference","count":68},{"language":"default","tag":"API reference","count":64},{"language":"en","tag":"Analytics \u0026 Integrations","count":53},{"language":"es","tag":"Analítica \u0026 Integraciones","count":52},{"language":"fr","tag":"Analyses et intégrations","count":52},{"language":"ja","tag":"分析 \u0026 統合","count":52},{"language":"ko","tag":"분석 \u0026 통합","count":52},{"language":"pt-BR","tag":"Análises \u0026 Integrações","count":52},{"language":"tr","tag":"Analitik ve Entegrasyonlar","count":52},{"language":"cn","tag":"分析和集成","count":51},{"language":"cn","tag":"开发者指南","count":48},{"language":"es","tag":"Guías del desarrollador","count":48},{"language":"fr","tag":"Guides développeur","count":48},{"language":"ja","tag":"開発者ガイド","count":48},{"language":"ko","tag":"개발자 가이드","count":48},{"language":"tr","tag":"Geliştirici Kılavuzları","count":48},{"language":"en","tag":"Developer Guides","count":47},{"language":"pt-BR","tag":"Guia de desenvolvedor","count":47},{"language":"en","tag":"Integrations","count":37},{"language":"es","tag":"Integraciones","count":37},{"language":"fr","tag":"Intégrations","count":37},{"language":"ja","tag":"統合","count":37},{"language":"ko","tag":"통합","count":37},{"language":"pt-BR","tag":"Integrações","count":37},{"language":"tr","tag":"Entegrasyonlar","count":37},{"language":"cn","tag":"集成","count":36},{"language":"en","tag":"Tutorials","count":35},{"language":"cn","tag":"推送通知","count":31},{"language":"cn","tag":"OneSignal 作为目的地","count":31},{"language":"en","tag":"Push","count":31},{"language":"en","tag":"OneSignal as destination","count":31},{"language":"es","tag":"Push notificaciones","count":31},{"language":"es","tag":"OneSignal como destino","count":31},{"language":"fr","tag":"Push","count":31},{"language":"fr","tag":"OneSignal comme destination","count":31},{"language":"ja","tag":"プッシュ通知","count":31},{"language":"ja","tag":"OneSignal as 宛先","count":31},{"language":"ko","tag":"푸시","count":31},{"language":"ko","tag":"OneSignal을 데이터 목적지로 사용","count":31},{"language":"pt-BR","tag":"Push notificações","count":31},{"language":"pt-BR","tag":"OneSignal como destino","count":31},{"language":"tr","tag":"Anlık bildirimler","count":31},{"language":"tr","tag":"OneSignal hedef","count":31},{"language":"en","tag":"Mobile SDKs","count":26},{"language":"cn","tag":"移动SDK","count":25},{"language":"es","tag":"SDKs móviles","count":25},{"language":"fr","tag":"SDK mobiles","count":25},{"language":"ja","tag":"モバイルSDK","count":25},{"language":"ko","tag":"모바일 SDKs","count":25},{"language":"pt-BR","tag":"SDKs móveis","count":25},{"language":"tr","tag":"Mobil SDK'lar","count":25},{"language":"cn","tag":"教程","count":24},{"language":"es","tag":"Tutoriales","count":24},{"language":"fr","tag":"Tutoriels","count":24},{"language":"ja","tag":"チュートリアル","count":24},{"language":"ko","tag":"튜토리얼","count":24},{"language":"pt-BR","tag":"Tutoriais","count":24},{"language":"tr","tag":"Eğitimler","count":24},{"language":"en","tag":"Mobile SDK setup","count":19},{"language":"cn","tag":"移动SDK设置","count":18},{"language":"es","tag":"Configuración del SDK móvil","count":18},{"language":"fr","tag":"Configuration SDK mobile","count":18},{"language":"ja","tag":"モバイルSDKセットアップ","count":18},{"language":"ko","tag":"모바일 SDK 설정","count":18},{"language":"pt-BR","tag":"Configuração do SDK móvel","count":18},{"language":"tr","tag":"Mobil SDK kurulumu","count":18},{"language":"default","tag":"Messages","count":9},{"language":"default","tag":"Users","count":9},{"language":"default","tag":"Organization","count":9},{"language":"default","tag":"Journeys","count":8},{"language":"default","tag":"Deprecated","count":6},{"language":"default","tag":"Templates","count":6},{"language":"default","tag":"Subscriptions","count":6},{"language":"default","tag":"Segments","count":5}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@onesignal.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"reference/update-journey-node","slug":"/reference/update-journey-node","pageMetadata":{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","description":"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.","keywords":["journeys API","journey nodes","journey automation","json merge patch","journey-node-not-found"],"href":"/reference/update-journey-node"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Beta.`}),` The Journeys API is in beta. Endpoints and response fields can still change.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`Update a single node within an existing `,_jsx(_components.a,{href:`/docs/en/journeys-overview`,children:`Journey`}),`. The request is a `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/html/rfc7396`,children:`JSON Merge Patch (RFC 7396)`}),`: send only the node fields you want to change, and the rest of the node, along with the rest of the journey graph, is left unchanged.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Prefer this endpoint over `,_jsx(_components.a,{href:`/reference/update-journey`,children:`Update journey`}),` when you only need to change one node. The journey-level PATCH replaces the entire `,_jsx(_components.code,{children:`nodes`}),` array wholesale, so it requires re-sending every node with its `,_jsx(_components.code,{children:`id`}),`. This endpoint touches just the addressed node and preserves in-flight users on the others.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-use-this-api`,children:`How to use this API`}),`\n`,_jsxs(_components.p,{children:[`Authenticate with your `,_jsx(_components.a,{href:`/docs/en/keys-and-ids`,children:`App API Key`}),`. The authenticated key must have permission to update journeys. Find the journey `,_jsx(_components.code,{children:`id`}),` and the node `,_jsx(_components.code,{children:`id`}),` from a prior `,_jsx(_components.a,{href:`/reference/view-journey`,children:`View journey`}),` fetch.`]}),`\n`,_jsxs(_components.p,{children:[`Send only the fields to change. Node fields follow the same schema and validation as `,_jsx(_components.a,{href:`/reference/create-journey`,children:`Create journey`}),`. For example, to shorten a `,_jsx(_components.code,{children:`wait`}),` node’s delay:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"duration_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`43200`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`merge-patch-behavior`,children:`Merge patch behavior`}),`\n`,_jsx(_components.p,{children:`The request body is merged onto the addressed node:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A field you send replaces the current value.`}),` Omitted fields are untouched.`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`A `,_jsx(_components.code,{children:`null`}),` value clears a nullable field.`]}),` Send `,_jsx(_components.code,{children:`\"expiration\": null`}),` on a `,_jsx(_components.code,{children:`wait_until`}),` node to wait indefinitely.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Arrays are replaced as a unit.`}),` `,_jsx(_components.code,{children:`branches`}),` and `,_jsx(_components.code,{children:`windows`}),` are not merged element-wise. Send the full array you want.`]}),`\n`,_jsxs(_components.li,{children:[`A node’s `,_jsx(_components.code,{children:`kind`}),` and its server-assigned `,_jsx(_components.code,{children:`id`}),` cannot be changed. A node keeps its kind for the life of its `,_jsx(_components.code,{children:`id`}),`, so changing the `,_jsx(_components.code,{children:`kind`}),` is rejected (`,_jsx(_components.code,{children:`send_push`}),`, `,_jsx(_components.code,{children:`send_email`}),`, and `,_jsx(_components.code,{children:`send_sms`}),` count as different kinds).`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`optimistic-concurrency`,children:`Optimistic concurrency`}),`\n`,_jsxs(_components.p,{children:[`To avoid overwriting a concurrent change, pass the `,_jsx(_components.code,{children:`concurrency_key`}),` returned by a prior `,_jsx(_components.a,{href:`/reference/view-journey`,children:`View journey`}),` fetch. If the journey has changed since that fetch, the request is rejected with `,_jsx(_components.code,{children:`409 journey-stale`}),` and nothing is written. Omit `,_jsx(_components.code,{children:`concurrency_key`}),` to skip the check.`]}),`\n`,_jsxs(_components.p,{children:[`The key covers the whole journey, not just the addressed node, so a concurrent edit to any part of the journey rejects the request. `,_jsx(_components.code,{children:`concurrency_key`}),` is not merged onto the node.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Treat `,_jsx(_components.code,{children:`concurrency_key`}),` as an opaque token: read it from the journey you are editing and send it back unchanged. Do not construct, parse, or compare it yourself.`]})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"duration_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`43200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"concurrency_key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"dcae4794fee16e450e448e37a6f8d0a5a7335755ff8cc76606e3d04b2f574e46\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`editing-an-active-journey`,children:`Editing an active journey`}),`\n`,_jsxs(_components.p,{children:[`The same active-journey rules as `,_jsx(_components.a,{href:`/reference/update-journey#editing-an-active-journey`,children:`Update journey`}),` apply. An edit that would strand in-flight users (for example, changing a branching node’s branches) returns `,_jsx(_components.code,{children:`400`}),` with a field-level error.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`A successful request returns `,_jsx(_components.code,{children:`200 OK`}),` with the full updated journey, including server-assigned `,_jsx(_components.code,{children:`id`}),` fields and a `,_jsx(_components.code,{children:`concurrency_key`}),`. Pass that `,_jsx(_components.code,{children:`concurrency_key`}),` unchanged on a later update to avoid overwriting a concurrent change.`]}),`\n`,_jsx(Heading,{level:`3`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid-payload`})}),_jsx(_components.td,{children:`The request failed validation. This covers schema failures and business-logic failures such as editing a structural node on an active journey.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`journey-not-entitled`})}),_jsx(_components.td,{children:`Journeys are not enabled for this app.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`journey-not-found`})}),_jsxs(_components.td,{children:[`No journey with that `,_jsx(_components.code,{children:`id`}),` exists for this app.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`journey-node-not-found`})}),_jsxs(_components.td,{children:[`No node with that `,_jsx(_components.code,{children:`node_id`}),` exists in the journey.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`journey-stale`})}),_jsxs(_components.td,{children:[`The supplied `,_jsx(_components.code,{children:`concurrency_key`}),` no longer matches the journey; it changed since it was last fetched.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`journey-archived`})}),_jsx(_components.td,{children:`Archived journeys cannot be edited.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{}),_jsxs(_components.td,{children:[`Rate limit exceeded. Wait the number of seconds in the `,_jsx(_components.code,{children:`Retry-After`}),` header before retrying. See `,_jsx(_components.a,{href:`/reference/rate-limits`,children:`Rate limits`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Coded errors use the shape `,_jsx(_components.code,{children:`{ \"errors\": [{ \"code\", \"title\", \"meta\" }] }`}),`. For validation errors the failing field is in `,_jsx(_components.code,{children:`meta.attribute`}),`. Schema failures on this endpoint are reported against the merged journey, so the offending property is identified in the message by its position in the full graph, such as `,_jsx(_components.code,{children:`#/nodes/1/bogus`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","description":"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.","keywords":["journeys API","journey nodes","journey automation","json merge patch","journey-node-not-found"],"href":"/reference/update-journey-node"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"How to use this API","slug":"how-to-use-this-api","depth":2,"children":[{"title":"Merge patch behavior","slug":"merge-patch-behavior","depth":3,"children":[]},{"title":"Optimistic concurrency","slug":"optimistic-concurrency","depth":3,"children":[]},{"title":"Editing an active journey","slug":"editing-an-active-journey","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"Error responses","slug":"error-responses","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/onesignal/e069c1b9f3157e14/hotjar-koala.js","/_mintlify/custom/onesignal/3e5d03885ab32f49/intercom.js","/_mintlify/custom/onesignal/dbb7af4794d1b586/munchkin-marketo.js"],"openApiReferenceData":{"operation":{"summary":"Update journey node","description":"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.","operationId":"update-journey-node","x-codeSamples":[{"lang":"typescript","label":"Node.js SDK","source":"import Onesignal from '@onesignal/node-onesignal';\n\nconst configuration = Onesignal.createConfiguration({\n restApiKey: 'YOUR_REST_API_KEY',\n});\nconst apiInstance = new Onesignal.DefaultApi(configuration);\n\n// string | Your OneSignal App ID in UUID v4 format.\nconst appId: string = \"YOUR_APP_ID\";\n// string | UUID of the journey that owns the node.\nconst journeyId: string = \"YOUR_JOURNEY_ID\";\n// string | Server-assigned UUID of the node to update, from a prior View journey fetch.\nconst nodeId: string = \"YOUR_NODE_ID\";\n// UpdateJourneyNodeRequest\nconst updateJourneyNodeRequest: Onesignal.UpdateJourneyNodeRequest = {};\n\ntry {\n const response = await apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n console.log(response);\n} catch (e) {\n if (e instanceof Onesignal.ApiException) {\n // `e.errorMessages` flattens any error-envelope shape to a `string[]`;\n // the raw parsed body remains on `e.body`.\n console.error(\"updateJourneyNode failed: HTTP \" + e.code, e.errorMessages);\n } else {\n throw e;\n }\n}"},{"lang":"python","label":"Python SDK","source":"import onesignal\nfrom onesignal.api import default_api\nfrom onesignal.models import *\nfrom pprint import pprint\n\n# See configuration.py for a list of all supported configuration parameters.\n# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY.\n# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself.\nconfiguration = onesignal.Configuration(\n rest_api_key = \"YOUR_REST_API_KEY\", # App REST API key required for most endpoints\n organization_api_key = \"YOUR_ORGANIZATION_API_KEY\" # Organization key is only required for creating new apps and other top-level endpoints\n)\n\n\n# Enter a context with an instance of the API client\nwith onesignal.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = default_api.DefaultApi(api_client)\n app_id = \"YOUR_APP_ID\" # Your OneSignal App ID in UUID v4 format. \n journey_id = \"YOUR_JOURNEY_ID\" # UUID of the journey that owns the node. \n node_id = \"YOUR_NODE_ID\" # Server-assigned UUID of the node to update, from a prior View journey fetch. \n update_journey_node_request = UpdateJourneyNodeRequest() \n\n try:\n # Update journey node\n api_response = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)\n pprint(api_response)\n except onesignal.ApiException as e:\n print(\"Exception when calling DefaultApi->update_journey_node: %s\\n\" % e)\n print(\"Status Code: %s\" % e.status)\n print(\"Response Body: %s\" % e.body)"},{"lang":"php","label":"PHP SDK","source":"\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n// Configure Bearer authorization: rest_api_key\n$config = onesignal\\client\\Configuration::getDefaultConfiguration()\n ->setRestApiKeyToken('YOUR_REST_API_KEY')\n ->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');\n\n\n\n$apiInstance = new onesignal\\client\\Api\\DefaultApi(\n // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n // This is optional, `GuzzleHttp\\Client` will be used as default.\n new GuzzleHttp\\Client(),\n $config\n);\n$app_id = 'YOUR_APP_ID'; // string | Your OneSignal App ID in UUID v4 format.\n$journey_id = 'YOUR_JOURNEY_ID'; // string | UUID of the journey that owns the node.\n$node_id = 'YOUR_NODE_ID'; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n$update_journey_node_request = new \\onesignal\\client\\model\\UpdateJourneyNodeRequest(); // \\onesignal\\client\\model\\UpdateJourneyNodeRequest\n\ntry {\n $result = $apiInstance->updateJourneyNode($app_id, $journey_id, $node_id, $update_journey_node_request);\n print_r($result);\n} catch (\\onesignal\\client\\ApiException $e) {\n echo 'Exception when calling DefaultApi->updateJourneyNode: ', $e->getMessage(), PHP_EOL;\n echo 'Status Code: ', $e->getCode(), PHP_EOL;\n // getErrorMessages() flattens any error-envelope shape to a string[];\n // the raw body remains on getResponseBody().\n echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;\n echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;\n} catch (\\Exception $e) {\n echo 'Exception when calling DefaultApi->updateJourneyNode: ', $e->getMessage(), PHP_EOL;\n}"},{"lang":"go","label":"Go SDK","source":"package main\n\nimport (\n \"context\"\n \"fmt\"\n \"os\"\n\n \"github.com/OneSignal/onesignal-go-api/v5\"\n)\n\nfunc main() {\n appId := \"YOUR_APP_ID\" // string | Your OneSignal App ID in UUID v4 format.\n journeyId := \"YOUR_JOURNEY_ID\" // string | UUID of the journey that owns the node.\n nodeId := \"YOUR_NODE_ID\" // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n updateJourneyNodeRequest := *onesignal.NewUpdateJourneyNodeRequest() // UpdateJourneyNodeRequest | \n\n configuration := onesignal.NewConfiguration()\n apiClient := onesignal.NewAPIClient(configuration)\n\n restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, \"YOUR_REST_API_KEY\") // App REST API key required for most endpoints\n\n resp, r, err := apiClient.DefaultApi.UpdateJourneyNode(restAuth, appId, journeyId, nodeId).UpdateJourneyNodeRequest(updateJourneyNodeRequest).Execute()\n\n if err != nil {\n fmt.Fprintf(os.Stderr, \"Error when calling `DefaultApi.UpdateJourneyNode``: %v\\n\", err)\n fmt.Fprintf(os.Stderr, \"Full HTTP response: %v\\n\", r)\n if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {\n // ErrorMessages() flattens any error-envelope shape to a []string;\n // the raw body remains on Body().\n fmt.Fprintf(os.Stderr, \"Error Messages: %v\\n\", apiErr.ErrorMessages())\n fmt.Fprintf(os.Stderr, \"Response Body: %s\\n\", apiErr.Body())\n }\n }\n // response from `UpdateJourneyNode`: Journey\n fmt.Fprintf(os.Stdout, \"Response from `DefaultApi.UpdateJourneyNode`: %v\\n\", resp)\n}"},{"lang":"ruby","label":"Ruby SDK","source":"require 'onesignal'\n# setup authorization\nOneSignal.configure do |config|\n # Configure Bearer authorization: rest_api_key\n config.rest_api_key = 'YOUR_REST_API_KEY'\n\nend\n\napi_instance = OneSignal::DefaultApi.new\napp_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.\njourney_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey that owns the node.\nnode_id = 'YOUR_NODE_ID' # String | Server-assigned UUID of the node to update, from a prior View journey fetch.\nupdate_journey_node_request = OneSignal::UpdateJourneyNodeRequest.new # UpdateJourneyNodeRequest | \n\nbegin\n # Update journey node\n result = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)\n p result\nrescue OneSignal::ApiError => e\n puts \"Error when calling DefaultApi->update_journey_node: #{e}\"\n puts \"Status Code: #{e.code}\"\n # `e.error_messages` flattens any error-envelope shape to an Array\u003cString>;\n # the raw body remains on `e.response_body`.\n puts \"Error Messages: #{e.error_messages}\"\n puts \"Response Body: #{e.response_body}\"\nend"},{"lang":"java","label":"Java SDK","source":"// Import classes:\nimport java.util.Arrays;\nimport java.util.List;\nimport com.onesignal.client.ApiClient;\nimport com.onesignal.client.ApiException;\nimport com.onesignal.client.Configuration;\nimport com.onesignal.client.auth.*;\nimport com.onesignal.client.model.*;\nimport com.onesignal.client.api.DefaultApi;\n\npublic class Example {\n public static void main(String[] args) {\n ApiClient defaultClient = Configuration.getDefaultApiClient();\n defaultClient.setBasePath(\"https://api.onesignal.com\");\n \n // Configure HTTP bearer authorization: rest_api_key\n HttpBearerAuth rest_api_key = (HttpBearerAuth) defaultClient.getAuthentication(\"rest_api_key\");\n rest_api_key.setBearerToken(\"YOUR_REST_API_KEY\");\n\n DefaultApi apiInstance = new DefaultApi(defaultClient);\n String appId = \"YOUR_APP_ID\"; // String | Your OneSignal App ID in UUID v4 format.\n String journeyId = \"YOUR_JOURNEY_ID\"; // String | UUID of the journey that owns the node.\n String nodeId = \"YOUR_NODE_ID\"; // String | Server-assigned UUID of the node to update, from a prior View journey fetch.\n UpdateJourneyNodeRequest updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest | \n try {\n Journey result = apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n System.out.println(result);\n } catch (ApiException e) {\n System.err.println(\"Exception when calling DefaultApi#updateJourneyNode\");\n System.err.println(\"Status code: \" + e.getCode());\n // getErrorMessages() flattens any error-envelope shape to a List\u003cString>;\n // the raw body remains on getResponseBody().\n System.err.println(\"Error messages: \" + e.getErrorMessages());\n System.err.println(\"Reason: \" + e.getResponseBody());\n System.err.println(\"Response headers: \" + e.getResponseHeaders());\n e.printStackTrace();\n }\n }\n}"},{"lang":"csharp","label":"C# SDK","source":"using System;\nusing System.Collections.Generic;\nusing System.Diagnostics;\nusing OneSignalApi.Api;\nusing OneSignalApi.Client;\nusing OneSignalApi.Model;\n\nnamespace Example\n{\n public class UpdateJourneyNodeExample\n {\n public static void Main()\n {\n Configuration config = new Configuration();\n config.BasePath = \"https://api.onesignal.com\";\n // Configure Bearer token for authorization: rest_api_key\n config.AccessToken = \"YOUR_REST_API_KEY\";\n\n var apiInstance = new DefaultApi(config);\n var appId = \"YOUR_APP_ID\"; // string | Your OneSignal App ID in UUID v4 format.\n var journeyId = \"YOUR_JOURNEY_ID\"; // string | UUID of the journey that owns the node.\n var nodeId = \"YOUR_NODE_ID\"; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n var updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest | \n\n try\n {\n // Update journey node\n Journey result = apiInstance.UpdateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n Debug.WriteLine(result);\n }\n catch (ApiException e)\n {\n Debug.Print(\"Exception when calling DefaultApi.UpdateJourneyNode: \" + e.Message );\n Debug.Print(\"Status Code: \"+ e.ErrorCode);\n // e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList\u003cstring>;\n // the raw body remains on e.ErrorContent.\n Debug.Print(\"Error Messages: \" + string.Join(\", \", e.ErrorMessages));\n Debug.Print(\"Response Body: \" + e.ErrorContent);\n Debug.Print(e.StackTrace);\n }\n }\n }\n}"},{"lang":"rust","label":"Rust SDK","source":"use onesignal_rust_api::apis::configuration::Configuration;\nuse onesignal_rust_api::apis::default_api;\n\nuse onesignal_rust_api::models;\n\n\n#[tokio::main]\nasync fn main() {\n let mut configuration = Configuration::new();\n configuration.rest_api_key_token = Some(\"YOUR_REST_API_KEY\".to_string());\n\n\n // Realistic values are pulled from the spec's `example:` fields where present.\n let app_id: \u0026str = \"YOUR_APP_ID\";\n let journey_id: \u0026str = \"YOUR_JOURNEY_ID\";\n let node_id: \u0026str = \"YOUR_NODE_ID\";\n let update_journey_node_request: models::UpdateJourneyNodeRequest = models::UpdateJourneyNodeRequest::new();\n\n match default_api::update_journey_node(\u0026configuration, app_id, journey_id, node_id, update_journey_node_request).await {\n Ok(resp) => println!(\"{:?}\", resp),\n Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {\n // `e.error_messages()` flattens any error-envelope shape to a Vec\u003cString>;\n // the raw response remains on the ResponseError variant.\n eprintln!(\"update_journey_node failed: {:?}\", e.error_messages());\n }\n Err(e) => eprintln!(\"update_journey_node failed: {:?}\", e),\n }\n}"}],"parameters":["f9004a54-3ce9-45a2-96d6-0142daf0308f","9e63687d-c143-4e42-bf73-74394d7c142b","d8a6e582-a8d6-4036-afc0-96f254e45e03","e520be27-315a-47ea-a7e6-84a361c9ed2a","3d1b8bfc-fb93-4143-8393-937746f2b0b5"],"requestBody":"944a4043-e43e-42fa-964c-d1f258443a92","responses":{"200":"f789d13a-d8f9-4810-909f-6e026070798e","400":"39b26eb6-896e-4f58-9e22-8ad2c02252df","403":"75796c00-ae7d-425d-8361-4c77c4d60583","404":"69a29fe0-c861-4342-a89f-4b5167139f55","409":"cd4eeaee-5598-451c-a08d-976e229e75f9","422":"f2720a98-6bcd-4d27-9c36-3d04e1758d63","429":"232bc4fd-39e2-4a1c-be0b-7561b2ff3cf5"},"method":"patch","type":"path","servers":["cf753503-cc1a-4f14-8e18-590f517b52c4"],"security":["c673d826-9e50-44e7-be1a-14cb91ce6281"],"path":"/apps/{app_id}/journeys/{id}/nodes/{node_id}","baseUrlOptions":["https://api.onesignal.com"],"title":"Update journey node","codeSamples":[{"label":"Node.js SDK","lang":"typescript","source":"import Onesignal from '@onesignal/node-onesignal';\n\nconst configuration = Onesignal.createConfiguration({\n restApiKey: 'YOUR_REST_API_KEY',\n});\nconst apiInstance = new Onesignal.DefaultApi(configuration);\n\n// string | Your OneSignal App ID in UUID v4 format.\nconst appId: string = \"YOUR_APP_ID\";\n// string | UUID of the journey that owns the node.\nconst journeyId: string = \"YOUR_JOURNEY_ID\";\n// string | Server-assigned UUID of the node to update, from a prior View journey fetch.\nconst nodeId: string = \"YOUR_NODE_ID\";\n// UpdateJourneyNodeRequest\nconst updateJourneyNodeRequest: Onesignal.UpdateJourneyNodeRequest = {};\n\ntry {\n const response = await apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n console.log(response);\n} catch (e) {\n if (e instanceof Onesignal.ApiException) {\n // `e.errorMessages` flattens any error-envelope shape to a `string[]`;\n // the raw parsed body remains on `e.body`.\n console.error(\"updateJourneyNode failed: HTTP \" + e.code, e.errorMessages);\n } else {\n throw e;\n }\n}"},{"label":"Python SDK","lang":"python","source":"import onesignal\nfrom onesignal.api import default_api\nfrom onesignal.models import *\nfrom pprint import pprint\n\n# See configuration.py for a list of all supported configuration parameters.\n# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY.\n# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself.\nconfiguration = onesignal.Configuration(\n rest_api_key = \"YOUR_REST_API_KEY\", # App REST API key required for most endpoints\n organization_api_key = \"YOUR_ORGANIZATION_API_KEY\" # Organization key is only required for creating new apps and other top-level endpoints\n)\n\n\n# Enter a context with an instance of the API client\nwith onesignal.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = default_api.DefaultApi(api_client)\n app_id = \"YOUR_APP_ID\" # Your OneSignal App ID in UUID v4 format. \n journey_id = \"YOUR_JOURNEY_ID\" # UUID of the journey that owns the node. \n node_id = \"YOUR_NODE_ID\" # Server-assigned UUID of the node to update, from a prior View journey fetch. \n update_journey_node_request = UpdateJourneyNodeRequest() \n\n try:\n # Update journey node\n api_response = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)\n pprint(api_response)\n except onesignal.ApiException as e:\n print(\"Exception when calling DefaultApi->update_journey_node: %s\\n\" % e)\n print(\"Status Code: %s\" % e.status)\n print(\"Response Body: %s\" % e.body)"},{"label":"PHP SDK","lang":"php","source":"\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n// Configure Bearer authorization: rest_api_key\n$config = onesignal\\client\\Configuration::getDefaultConfiguration()\n ->setRestApiKeyToken('YOUR_REST_API_KEY')\n ->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');\n\n\n\n$apiInstance = new onesignal\\client\\Api\\DefaultApi(\n // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n // This is optional, `GuzzleHttp\\Client` will be used as default.\n new GuzzleHttp\\Client(),\n $config\n);\n$app_id = 'YOUR_APP_ID'; // string | Your OneSignal App ID in UUID v4 format.\n$journey_id = 'YOUR_JOURNEY_ID'; // string | UUID of the journey that owns the node.\n$node_id = 'YOUR_NODE_ID'; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n$update_journey_node_request = new \\onesignal\\client\\model\\UpdateJourneyNodeRequest(); // \\onesignal\\client\\model\\UpdateJourneyNodeRequest\n\ntry {\n $result = $apiInstance->updateJourneyNode($app_id, $journey_id, $node_id, $update_journey_node_request);\n print_r($result);\n} catch (\\onesignal\\client\\ApiException $e) {\n echo 'Exception when calling DefaultApi->updateJourneyNode: ', $e->getMessage(), PHP_EOL;\n echo 'Status Code: ', $e->getCode(), PHP_EOL;\n // getErrorMessages() flattens any error-envelope shape to a string[];\n // the raw body remains on getResponseBody().\n echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;\n echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;\n} catch (\\Exception $e) {\n echo 'Exception when calling DefaultApi->updateJourneyNode: ', $e->getMessage(), PHP_EOL;\n}"},{"label":"Go SDK","lang":"go","source":"package main\n\nimport (\n \"context\"\n \"fmt\"\n \"os\"\n\n \"github.com/OneSignal/onesignal-go-api/v5\"\n)\n\nfunc main() {\n appId := \"YOUR_APP_ID\" // string | Your OneSignal App ID in UUID v4 format.\n journeyId := \"YOUR_JOURNEY_ID\" // string | UUID of the journey that owns the node.\n nodeId := \"YOUR_NODE_ID\" // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n updateJourneyNodeRequest := *onesignal.NewUpdateJourneyNodeRequest() // UpdateJourneyNodeRequest | \n\n configuration := onesignal.NewConfiguration()\n apiClient := onesignal.NewAPIClient(configuration)\n\n restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, \"YOUR_REST_API_KEY\") // App REST API key required for most endpoints\n\n resp, r, err := apiClient.DefaultApi.UpdateJourneyNode(restAuth, appId, journeyId, nodeId).UpdateJourneyNodeRequest(updateJourneyNodeRequest).Execute()\n\n if err != nil {\n fmt.Fprintf(os.Stderr, \"Error when calling `DefaultApi.UpdateJourneyNode``: %v\\n\", err)\n fmt.Fprintf(os.Stderr, \"Full HTTP response: %v\\n\", r)\n if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {\n // ErrorMessages() flattens any error-envelope shape to a []string;\n // the raw body remains on Body().\n fmt.Fprintf(os.Stderr, \"Error Messages: %v\\n\", apiErr.ErrorMessages())\n fmt.Fprintf(os.Stderr, \"Response Body: %s\\n\", apiErr.Body())\n }\n }\n // response from `UpdateJourneyNode`: Journey\n fmt.Fprintf(os.Stdout, \"Response from `DefaultApi.UpdateJourneyNode`: %v\\n\", resp)\n}"},{"label":"Ruby SDK","lang":"ruby","source":"require 'onesignal'\n# setup authorization\nOneSignal.configure do |config|\n # Configure Bearer authorization: rest_api_key\n config.rest_api_key = 'YOUR_REST_API_KEY'\n\nend\n\napi_instance = OneSignal::DefaultApi.new\napp_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.\njourney_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey that owns the node.\nnode_id = 'YOUR_NODE_ID' # String | Server-assigned UUID of the node to update, from a prior View journey fetch.\nupdate_journey_node_request = OneSignal::UpdateJourneyNodeRequest.new # UpdateJourneyNodeRequest | \n\nbegin\n # Update journey node\n result = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)\n p result\nrescue OneSignal::ApiError => e\n puts \"Error when calling DefaultApi->update_journey_node: #{e}\"\n puts \"Status Code: #{e.code}\"\n # `e.error_messages` flattens any error-envelope shape to an Array\u003cString>;\n # the raw body remains on `e.response_body`.\n puts \"Error Messages: #{e.error_messages}\"\n puts \"Response Body: #{e.response_body}\"\nend"},{"label":"Java SDK","lang":"java","source":"// Import classes:\nimport java.util.Arrays;\nimport java.util.List;\nimport com.onesignal.client.ApiClient;\nimport com.onesignal.client.ApiException;\nimport com.onesignal.client.Configuration;\nimport com.onesignal.client.auth.*;\nimport com.onesignal.client.model.*;\nimport com.onesignal.client.api.DefaultApi;\n\npublic class Example {\n public static void main(String[] args) {\n ApiClient defaultClient = Configuration.getDefaultApiClient();\n defaultClient.setBasePath(\"https://api.onesignal.com\");\n \n // Configure HTTP bearer authorization: rest_api_key\n HttpBearerAuth rest_api_key = (HttpBearerAuth) defaultClient.getAuthentication(\"rest_api_key\");\n rest_api_key.setBearerToken(\"YOUR_REST_API_KEY\");\n\n DefaultApi apiInstance = new DefaultApi(defaultClient);\n String appId = \"YOUR_APP_ID\"; // String | Your OneSignal App ID in UUID v4 format.\n String journeyId = \"YOUR_JOURNEY_ID\"; // String | UUID of the journey that owns the node.\n String nodeId = \"YOUR_NODE_ID\"; // String | Server-assigned UUID of the node to update, from a prior View journey fetch.\n UpdateJourneyNodeRequest updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest | \n try {\n Journey result = apiInstance.updateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n System.out.println(result);\n } catch (ApiException e) {\n System.err.println(\"Exception when calling DefaultApi#updateJourneyNode\");\n System.err.println(\"Status code: \" + e.getCode());\n // getErrorMessages() flattens any error-envelope shape to a List\u003cString>;\n // the raw body remains on getResponseBody().\n System.err.println(\"Error messages: \" + e.getErrorMessages());\n System.err.println(\"Reason: \" + e.getResponseBody());\n System.err.println(\"Response headers: \" + e.getResponseHeaders());\n e.printStackTrace();\n }\n }\n}"},{"label":"C# SDK","lang":"csharp","source":"using System;\nusing System.Collections.Generic;\nusing System.Diagnostics;\nusing OneSignalApi.Api;\nusing OneSignalApi.Client;\nusing OneSignalApi.Model;\n\nnamespace Example\n{\n public class UpdateJourneyNodeExample\n {\n public static void Main()\n {\n Configuration config = new Configuration();\n config.BasePath = \"https://api.onesignal.com\";\n // Configure Bearer token for authorization: rest_api_key\n config.AccessToken = \"YOUR_REST_API_KEY\";\n\n var apiInstance = new DefaultApi(config);\n var appId = \"YOUR_APP_ID\"; // string | Your OneSignal App ID in UUID v4 format.\n var journeyId = \"YOUR_JOURNEY_ID\"; // string | UUID of the journey that owns the node.\n var nodeId = \"YOUR_NODE_ID\"; // string | Server-assigned UUID of the node to update, from a prior View journey fetch.\n var updateJourneyNodeRequest = new UpdateJourneyNodeRequest(); // UpdateJourneyNodeRequest | \n\n try\n {\n // Update journey node\n Journey result = apiInstance.UpdateJourneyNode(appId, journeyId, nodeId, updateJourneyNodeRequest);\n Debug.WriteLine(result);\n }\n catch (ApiException e)\n {\n Debug.Print(\"Exception when calling DefaultApi.UpdateJourneyNode: \" + e.Message );\n Debug.Print(\"Status Code: \"+ e.ErrorCode);\n // e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList\u003cstring>;\n // the raw body remains on e.ErrorContent.\n Debug.Print(\"Error Messages: \" + string.Join(\", \", e.ErrorMessages));\n Debug.Print(\"Response Body: \" + e.ErrorContent);\n Debug.Print(e.StackTrace);\n }\n }\n }\n}"},{"label":"Rust SDK","lang":"rust","source":"use onesignal_rust_api::apis::configuration::Configuration;\nuse onesignal_rust_api::apis::default_api;\n\nuse onesignal_rust_api::models;\n\n\n#[tokio::main]\nasync fn main() {\n let mut configuration = Configuration::new();\n configuration.rest_api_key_token = Some(\"YOUR_REST_API_KEY\".to_string());\n\n\n // Realistic values are pulled from the spec's `example:` fields where present.\n let app_id: \u0026str = \"YOUR_APP_ID\";\n let journey_id: \u0026str = \"YOUR_JOURNEY_ID\";\n let node_id: \u0026str = \"YOUR_NODE_ID\";\n let update_journey_node_request: models::UpdateJourneyNodeRequest = models::UpdateJourneyNodeRequest::new();\n\n match default_api::update_journey_node(\u0026configuration, app_id, journey_id, node_id, update_journey_node_request).await {\n Ok(resp) => println!(\"{:?}\", resp),\n Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {\n // `e.error_messages()` flattens any error-envelope shape to a Vec\u003cString>;\n // the raw response remains on the ResponseError variant.\n eprintln!(\"update_journey_node failed: {:?}\", e.error_messages());\n }\n Err(e) => eprintln!(\"update_journey_node failed: {:?}\", e),\n }\n}"}],"requestExampleLanguages":["bash","typescript","python","php","go","ruby","java","csharp","rust"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"f9004a54-3ce9-45a2-96d6-0142daf0308f":{"name":"app_id","in":"path","description":"Your OneSignal App ID in UUID v4 format. See [Keys \u0026 IDs](/docs/en/keys-and-ids).","schema":{"type":"string","default":"YOUR_APP_ID","isRequired":true,"description":"Your OneSignal App ID in UUID v4 format. See [Keys \u0026 IDs](/docs/en/keys-and-ids).","uniqueKey":"","typeLabel":"string"},"required":true},"9e63687d-c143-4e42-bf73-74394d7c142b":{"name":"id","in":"path","description":"UUID of the journey that owns the node.","required":true,"schema":{"type":"string","default":"YOUR_JOURNEY_ID","isRequired":true,"description":"UUID of the journey that owns the node.","uniqueKey":"","typeLabel":"string"}},"d8a6e582-a8d6-4036-afc0-96f254e45e03":{"name":"node_id","in":"path","description":"Server-assigned UUID of the node to update, from a prior [View journey](/reference/view-journey) fetch.","required":true,"schema":{"type":"string","default":"YOUR_NODE_ID","isRequired":true,"description":"Server-assigned UUID of the node to update, from a prior [View journey](/reference/view-journey) fetch.","uniqueKey":"","typeLabel":"string"}},"e520be27-315a-47ea-a7e6-84a361c9ed2a":{"name":"Authorization","in":"header","description":"Your App API key with prefix `Key `. See [Keys \u0026 IDs](/docs/en/keys-and-ids).","required":true,"schema":{"type":"string","default":"Key YOUR_APP_API_KEY","isRequired":true,"description":"Your App API key with prefix `Key `. See [Keys \u0026 IDs](/docs/en/keys-and-ids).","uniqueKey":"","typeLabel":"string"}},"3d1b8bfc-fb93-4143-8393-937746f2b0b5":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","default":"application/json; charset=utf-8","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"Node fields to change, merged onto the current node. The node's `kind` and `id` cannot be changed. Send `null` to clear a nullable field.","properties":{"concurrency_key":{"oneOf":[{"type":"string","description":"Optional optimistic-concurrency token. Pass the `concurrency_key` from a prior fetch to reject the update with `409` if the journey changed in the meantime. Omit to skip the check. It is not merged onto the node.","uniqueKey":"concurrency_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional optimistic-concurrency token. Pass the `concurrency_key` from a prior fetch to reject the update with `409` if the journey changed in the meantime. Omit to skip the check. It is not merged onto the node.","uniqueKey":"concurrency_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"concurrency_key","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"duration_seconds":43200},"examples":{"Example":{"title":"Example","value":{"duration_seconds":43200}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"f789d13a-d8f9-4810-909f-6e026070798e":{"description":"200","content":{"application/json":{"schema":{"type":"object","description":"Full journey representation returned by the detail and create endpoints.","properties":{"id":{"type":"string","description":"Journey UUID. Read-only.","uniqueKey":"id","typeLabel":"string"},"app_id":{"type":"string","description":"UUID of the app the journey belongs to. Read-only.","uniqueKey":"app_id","typeLabel":"string"},"name":{"type":"string","description":"Journey name, up to 300 characters.","uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Journey description, up to 1024 characters. Defaults to an empty string.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Journey description, up to 1024 characters. Defaults to an empty string.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"state":{"type":"string","enum":["draft","scheduled","processing","active","archived"],"description":"Journey state. Read-only. New journeys are created as `draft`. `processing` is a transient state while an activation is in progress, and `archived` is a journey that has been stopped. Change it through the `state` field on [Update journey](/reference/update-journey).","uniqueKey":"state","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","description":"ISO 8601 creation time. Read-only.","uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"ISO 8601 last-update time. Read-only.","uniqueKey":"updated_at","typeLabel":"string"},"started_at":{"oneOf":[{"type":"string","description":"ISO 8601 time the journey was activated, or `null`. Read-only. May stay `null` briefly after you set `state` to `active`: activation is enqueued for processing, and `started_at` populates once the journey finishes processing and becomes active.","uniqueKey":"started_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 time the journey was activated, or `null`. Read-only. May stay `null` briefly after you set `state` to `active`: activation is enqueued for processing, and `started_at` populates once the journey finishes processing and becomes active.","uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"started_at","typeLabel":"string | null"},"archived_at":{"oneOf":[{"type":"string","description":"ISO 8601 time the journey was archived, or `null`. Read-only.","uniqueKey":"archived_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 time the journey was archived, or `null`. Read-only.","uniqueKey":"archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived_at","typeLabel":"string | null"},"created_source":{"oneOf":[{"type":"string","description":"Origin of the journey, for example `public_api` or `dashboard`. Read-only.","uniqueKey":"created_source.oneOf.0","typeLabel":"string"},{"type":"null","description":"Origin of the journey, for example `public_api` or `dashboard`. Read-only.","uniqueKey":"created_source.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_source","typeLabel":"string | null"},"audience":{"oneOf":[{"type":"object","title":"segment","description":"The journey entry audience. Either a segment-based or event-triggered audience.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment","isRequired":true,"uniqueKey":"audience.oneOf.0.kind","typeLabel":"string"},"included_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"audience.oneOf.0.included_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs whose users enter the journey.","uniqueKey":"audience.oneOf.0.included_segment_ids","typeLabel":"string[]"},"excluded_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"audience.oneOf.0.excluded_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs whose users are excluded.","uniqueKey":"audience.oneOf.0.excluded_segment_ids","typeLabel":"string[]"},"future_additions_only":{"type":"boolean","description":"When true, only users who newly match the segment after activation enter the journey. Defaults to false.","uniqueKey":"audience.oneOf.0.future_additions_only","typeLabel":"boolean"}},"uniqueKey":"audience.oneOf.0","typeLabel":"segment · object"},{"type":"object","title":"event_trigger","description":"The journey entry audience. Either a segment-based or event-triggered audience.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true,"uniqueKey":"audience.oneOf.1.kind","typeLabel":"string"},"name":{"type":"string","description":"Event name that triggers entry, up to 255 characters.","uniqueKey":"audience.oneOf.1.name","typeLabel":"string"},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true,"uniqueKey":"audience.oneOf.1.attributes.items.[INDEX].items.[INDEX].key","typeLabel":"string"},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true,"uniqueKey":"audience.oneOf.1.attributes.items.[INDEX].items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`.","uniqueKey":"audience.oneOf.1.attributes.items.[INDEX].items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"audience.oneOf.1.attributes.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"audience.oneOf.1.attributes.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"audience.oneOf.1.attributes","typeLabel":"object[][]"}},"uniqueKey":"audience.oneOf.1","typeLabel":"event_trigger · object"}],"uniqueKey":"audience","typeLabel":"segment · object | event_trigger · object"},"early_exit":{"oneOf":[{"type":"object","description":"Conditions that remove a user from the journey before it completes. At least one rule must be set under `rules`; an early_exit that configures no rule is rejected. Send `null` to remove early exit entirely, or `null` for an individual rule to drop just that rule.","properties":{"rules":{"type":"object","properties":{"on_segment":{"oneOf":[{"type":"object","properties":{"included_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"early_exit.oneOf.0.rules.on_segment.oneOf.0.included_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Exit when the user enters any of these segments.","uniqueKey":"early_exit.oneOf.0.rules.on_segment.oneOf.0.included_segment_ids","typeLabel":"string[]"}},"uniqueKey":"early_exit.oneOf.0.rules.on_segment.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Exit when the user enters any of these segments."}},"uniqueKey":"early_exit.oneOf.0.rules.on_segment.oneOf.1","typeLabel":"null"}],"uniqueKey":"early_exit.oneOf.0.rules.on_segment","typeLabel":"object | null"},"when_not_in_audience":{"oneOf":[{"type":"boolean","description":"Exit when the user no longer matches the journey audience. Defaults to false.","uniqueKey":"early_exit.oneOf.0.rules.when_not_in_audience.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Exit when the user no longer matches the journey audience. Defaults to false.","uniqueKey":"early_exit.oneOf.0.rules.when_not_in_audience.oneOf.1","typeLabel":"null"}],"uniqueKey":"early_exit.oneOf.0.rules.when_not_in_audience","typeLabel":"boolean | null"},"on_session":{"oneOf":[{"type":"boolean","description":"Exit on a new session start. Defaults to false.","uniqueKey":"early_exit.oneOf.0.rules.on_session.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Exit on a new session start. Defaults to false.","uniqueKey":"early_exit.oneOf.0.rules.on_session.oneOf.1","typeLabel":"null"}],"uniqueKey":"early_exit.oneOf.0.rules.on_session","typeLabel":"boolean | null"},"on_event":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Exit when this event occurs. Up to 255 characters.","isRequired":true,"uniqueKey":"early_exit.oneOf.0.rules.on_event.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"early_exit.oneOf.0.rules.on_event.oneOf.0","typeLabel":"object"},{"type":"null","required":["name"],"properties":{"name":{"type":"string","description":"Exit when this event occurs. Up to 255 characters."}},"uniqueKey":"early_exit.oneOf.0.rules.on_event.oneOf.1","typeLabel":"null"}],"uniqueKey":"early_exit.oneOf.0.rules.on_event","typeLabel":"object | null"}},"uniqueKey":"early_exit.oneOf.0.rules","typeLabel":"object"},"tag_on_early_exit":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"early_exit.oneOf.0.tag_on_early_exit.additionalProperties","typeLabel":"string"},"description":"Tag key-value pairs applied when a user exits early.","uniqueKey":"early_exit.oneOf.0.tag_on_early_exit","typeLabel":"object"}},"uniqueKey":"early_exit.oneOf.0","typeLabel":"object"},{"type":"null","description":"Conditions that remove a user from the journey before it completes. At least one rule must be set under `rules`; an early_exit that configures no rule is rejected. Send `null` to remove early exit entirely, or `null` for an individual rule to drop just that rule.","properties":{"rules":{"type":"object","properties":{"on_segment":{"oneOf":[{"type":"object","properties":{"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Exit when the user enters any of these segments."}}},{"type":"null","properties":{"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Exit when the user enters any of these segments."}}}]},"when_not_in_audience":{"oneOf":[{"type":"boolean","description":"Exit when the user no longer matches the journey audience. Defaults to false."},{"type":"null","description":"Exit when the user no longer matches the journey audience. Defaults to false."}]},"on_session":{"oneOf":[{"type":"boolean","description":"Exit on a new session start. Defaults to false."},{"type":"null","description":"Exit on a new session start. Defaults to false."}]},"on_event":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Exit when this event occurs. Up to 255 characters."}}},{"type":"null","required":["name"],"properties":{"name":{"type":"string","description":"Exit when this event occurs. Up to 255 characters."}}}]}}},"tag_on_early_exit":{"type":"object","additionalProperties":{"type":"string"},"description":"Tag key-value pairs applied when a user exits early."}},"uniqueKey":"early_exit.oneOf.1","typeLabel":"null"}],"uniqueKey":"early_exit","typeLabel":"object | null"},"reentry_rules":{"oneOf":[{"type":"object","description":"Controls whether and how soon a user can re-enter the journey. `null` means re-entry is not allowed.","properties":{"duration_seconds":{"type":"integer","minimum":600,"description":"Minimum seconds before a user can re-enter. Must be at least `600` (10 minutes).","uniqueKey":"reentry_rules.oneOf.0.duration_seconds","typeLabel":"integer"}},"uniqueKey":"reentry_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Controls whether and how soon a user can re-enter the journey. `null` means re-entry is not allowed.","properties":{"duration_seconds":{"type":"integer","minimum":600,"description":"Minimum seconds before a user can re-enter. Must be at least `600` (10 minutes)."}},"uniqueKey":"reentry_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"reentry_rules","typeLabel":"object | null"},"schedule":{"oneOf":[{"type":"object","description":"Optional future start and/or stop time. `null` means no scheduled activation.","properties":{"start_at":{"oneOf":[{"type":"string","description":"ISO 8601 start time. Use UTC (`Z` or `+00:00`). Must be at least 5 minutes in the future.","uniqueKey":"schedule.oneOf.0.start_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 start time. Use UTC (`Z` or `+00:00`). Must be at least 5 minutes in the future.","uniqueKey":"schedule.oneOf.0.start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.start_at","typeLabel":"string | null"},"stop_at":{"oneOf":[{"type":"string","description":"ISO 8601 stop time. Use UTC (`Z` or `+00:00`). Must be in the future and later than `start_at`.","uniqueKey":"schedule.oneOf.0.stop_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 stop time. Use UTC (`Z` or `+00:00`). Must be in the future and later than `start_at`.","uniqueKey":"schedule.oneOf.0.stop_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.stop_at","typeLabel":"string | null"},"error":{"oneOf":[{"type":"string","description":"Read-only. Present when a scheduling error occurred.","uniqueKey":"schedule.oneOf.0.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. Present when a scheduling error occurred.","uniqueKey":"schedule.oneOf.0.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.error","typeLabel":"string | null"}},"uniqueKey":"schedule.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional future start and/or stop time. `null` means no scheduled activation.","properties":{"start_at":{"oneOf":[{"type":"string","description":"ISO 8601 start time. Use UTC (`Z` or `+00:00`). Must be at least 5 minutes in the future."},{"type":"null","description":"ISO 8601 start time. Use UTC (`Z` or `+00:00`). Must be at least 5 minutes in the future."}]},"stop_at":{"oneOf":[{"type":"string","description":"ISO 8601 stop time. Use UTC (`Z` or `+00:00`). Must be in the future and later than `start_at`."},{"type":"null","description":"ISO 8601 stop time. Use UTC (`Z` or `+00:00`). Must be in the future and later than `start_at`."}]},"error":{"oneOf":[{"type":"string","description":"Read-only. Present when a scheduling error occurred."},{"type":"null","description":"Read-only. Present when a scheduling error occurred."}]}},"uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"object | null"},"nodes":{"type":"array","items":{"oneOf":[{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"wait","description":"Holds the user for a fixed duration before continuing.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.0.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.0.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.0.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.0.annotation","typeLabel":"string"},"duration_seconds":{"type":"integer","description":"Seconds to hold the user. Minimum `60`, maximum `31556952` (1 year).","minimum":60,"maximum":31556952,"uniqueKey":"nodes.items.[INDEX].oneOf.0.duration_seconds","typeLabel":"integer"}},"uniqueKey":"nodes.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"time_window","description":"Holds the user until the next configured time window opens.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.1.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.1.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.1.annotation","typeLabel":"string"},"relative_to":{"type":"string","enum":["schedule_in_timezone","last_active_time"],"description":"`schedule_in_timezone` uses the configured windows; `last_active_time` holds relative to the user's last active time.","uniqueKey":"nodes.items.[INDEX].oneOf.1.relative_to","typeLabel":"enum\u003cstring>"},"windows":{"type":"array","items":{"type":"object","properties":{"start":{"type":"object","description":"When the window opens.","properties":{"hour":{"type":"integer","minimum":0,"maximum":23,"description":"Hour of day, 0-23.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].start.hour","typeLabel":"integer"},"minute":{"type":"integer","minimum":0,"maximum":59,"description":"Minute of hour, 0-59. Defaults to 0.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].start.minute","typeLabel":"integer"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].start","typeLabel":"object"},"end":{"type":"object","description":"When the window closes.","properties":{"hour":{"type":"integer","minimum":0,"maximum":23,"description":"Hour of day, 0-23.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].end.hour","typeLabel":"integer"},"minute":{"type":"integer","minimum":0,"maximum":59,"description":"Minute of hour, 0-59. Defaults to 0.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].end.minute","typeLabel":"integer"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].end","typeLabel":"object"},"day_of_week":{"type":"integer","minimum":1,"maximum":7,"description":"Day of week, 1 = Monday. Omit to apply the window to every day.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX].day_of_week","typeLabel":"integer"}},"description":"A wall-clock window. Each window must span at least 15 minutes.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows.items.[INDEX]","typeLabel":"object"},"description":"One or more time windows. A window with no `day_of_week` applies to every day, and is returned in that same day-agnostic form. Required when `relative_to` is `schedule_in_timezone`; must be omitted when it is `last_active_time`, and is absent from responses for those nodes.","uniqueKey":"nodes.items.[INDEX].oneOf.1.windows","typeLabel":"object[]"},"time_zone":{"type":"string","description":"IANA timezone identifier used when the user's timezone is unavailable.","uniqueKey":"nodes.items.[INDEX].oneOf.1.time_zone","typeLabel":"string"},"use_user_time_zone":{"type":"boolean","description":"When true, uses the user's timezone if available.","uniqueKey":"nodes.items.[INDEX].oneOf.1.use_user_time_zone","typeLabel":"boolean"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","enum":["send_push","send_email","send_sms"],"description":"Sends a message on the given channel using a template.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.2.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.2.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.2.annotation","typeLabel":"string"},"template_id":{"type":"string","description":"UUID of the template to send.","uniqueKey":"nodes.items.[INDEX].oneOf.2.template_id","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"send_iam","description":"Sends an in-app message.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.3.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.3.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.3.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.3.annotation","typeLabel":"string"},"iam_id":{"type":"string","description":"UUID of the in-app message to send.","uniqueKey":"nodes.items.[INDEX].oneOf.3.iam_id","typeLabel":"string"},"user_ttl_seconds":{"type":"integer","minimum":1,"description":"Optional time-to-live for the in-app message, in seconds.","uniqueKey":"nodes.items.[INDEX].oneOf.3.user_ttl_seconds","typeLabel":"integer"}},"uniqueKey":"nodes.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"send_webhook","description":"Sends a webhook.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.4.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.4.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.4.annotation","typeLabel":"string"},"webhook_id":{"type":"string","description":"UUID of the webhook to send.","uniqueKey":"nodes.items.[INDEX].oneOf.4.webhook_id","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"tag","description":"Assigns key-value tags to the user.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.5.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.5.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.5.annotation","typeLabel":"string"},"assignments":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.5.assignments.additionalProperties","typeLabel":"string"},"description":"Tag key-value pairs to assign. An empty string value removes the tag. Keys are limited to 255 characters and values to 1024.","uniqueKey":"nodes.items.[INDEX].oneOf.5.assignments","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"split_range","description":"Routes users into weighted branches that converge to the next sibling node.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.6.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.6.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.6.annotation","typeLabel":"string"},"randomize_on_entry":{"type":"boolean","description":"When true, assigns each user to a branch at random on entry. Defaults to false.","uniqueKey":"nodes.items.[INDEX].oneOf.6.randomize_on_entry","typeLabel":"boolean"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].id","typeLabel":"string"},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0.kind","typeLabel":"string"},"included_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0.included_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0.included_segment_ids","typeLabel":"string[]"},"excluded_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must not belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids","typeLabel":"string[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.0","typeLabel":"segment_membership · object"},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.1.kind","typeLabel":"string"},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.1.action","typeLabel":"enum\u003cstring>"},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.1.sending_node_id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.1.client_node_id","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.1","typeLabel":"on_notification_action · object"},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.kind","typeLabel":"string"},"name":{"type":"string","description":"Event name, up to 255 characters.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.name","typeLabel":"string"},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].key","typeLabel":"string"},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.attributes","typeLabel":"object[][]"},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes","typeLabel":"object[] | null"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition.oneOf.2","typeLabel":"event_trigger · object"}],"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].condition","typeLabel":"segment_membership · object | on_notification_action · object | event_trigger · object"},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].weight","typeLabel":"number"},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node.","uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX].nodes","typeLabel":"array"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches.items.[INDEX]","typeLabel":"object"},"description":"Weighted branches. Between 2 and 25. Weights must sum to 100. Order determines display order.","minItems":2,"maxItems":25,"uniqueKey":"nodes.items.[INDEX].oneOf.6.branches","typeLabel":"object[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"yes_no","description":"Routes users into a yes or no branch based on a condition.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.7.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.7.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.7.annotation","typeLabel":"string"},"branches":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].id","typeLabel":"string"},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0.kind","typeLabel":"string"},"included_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0.included_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0.included_segment_ids","typeLabel":"string[]"},"excluded_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must not belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids","typeLabel":"string[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.0","typeLabel":"segment_membership · object"},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.1.kind","typeLabel":"string"},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.1.action","typeLabel":"enum\u003cstring>"},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.1.sending_node_id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.1.client_node_id","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.1","typeLabel":"on_notification_action · object"},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.kind","typeLabel":"string"},"name":{"type":"string","description":"Event name, up to 255 characters.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.name","typeLabel":"string"},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].key","typeLabel":"string"},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.attributes","typeLabel":"object[][]"},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes","typeLabel":"object[] | null"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition.oneOf.2","typeLabel":"event_trigger · object"}],"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].condition","typeLabel":"segment_membership · object | on_notification_action · object | event_trigger · object"},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].weight","typeLabel":"number"},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX].nodes","typeLabel":"array"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7.branches.items.[INDEX]","typeLabel":"object"},"description":"Exactly two branches. The branch with a `condition` is the \"yes\" branch; the branch without one is the \"no\" branch.","uniqueKey":"nodes.items.[INDEX].oneOf.7.branches","typeLabel":"object[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"wait_until","description":"Holds the user until any branch condition is met, or an optional expiration timer fires.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.kind","typeLabel":"string"},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error.","uniqueKey":"nodes.items.[INDEX].oneOf.8.id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads.","uniqueKey":"nodes.items.[INDEX].oneOf.8.client_node_id","typeLabel":"string"},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior.","uniqueKey":"nodes.items.[INDEX].oneOf.8.annotation","typeLabel":"string"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].id","typeLabel":"string"},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0.kind","typeLabel":"string"},"included_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0.included_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0.included_segment_ids","typeLabel":"string[]"},"excluded_segment_ids":{"type":"array","items":{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids.items.[INDEX]","typeLabel":"string"},"description":"Segment UUIDs the user must not belong to.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0.excluded_segment_ids","typeLabel":"string[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.0","typeLabel":"segment_membership · object"},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.1.kind","typeLabel":"string"},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.1.action","typeLabel":"enum\u003cstring>"},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.1.sending_node_id","typeLabel":"string"},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.1.client_node_id","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.1","typeLabel":"on_notification_action · object"},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.kind","typeLabel":"string"},"name":{"type":"string","description":"Event name, up to 255 characters.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.name","typeLabel":"string"},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].key","typeLabel":"string"},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.attributes","typeLabel":"object[][]"},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2.entry_event_match_attributes","typeLabel":"object[] | null"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition.oneOf.2","typeLabel":"event_trigger · object"}],"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].condition","typeLabel":"segment_membership · object | on_notification_action · object | event_trigger · object"},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].weight","typeLabel":"number"},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node.","uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX].nodes","typeLabel":"array"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches.items.[INDEX]","typeLabel":"object"},"description":"Condition branches. At least one required, at most 25. Order determines priority.","minItems":1,"maxItems":25,"uniqueKey":"nodes.items.[INDEX].oneOf.8.branches","typeLabel":"object[]"},"expiration":{"oneOf":[{"type":"object","properties":{"duration_seconds":{"type":"integer","minimum":60,"description":"Seconds to wait before the timer fires. Minimum `60`, maximum `31556952` (1 year).","maximum":31556952,"uniqueKey":"nodes.items.[INDEX].oneOf.8.expiration.oneOf.0.duration_seconds","typeLabel":"integer"},"exits":{"type":"boolean","description":"When true, the user exits the journey when the timer fires; when false, the user continues to convergence.","uniqueKey":"nodes.items.[INDEX].oneOf.8.expiration.oneOf.0.exits","typeLabel":"boolean"}},"description":"Optional expiration timer. `null` waits indefinitely.","uniqueKey":"nodes.items.[INDEX].oneOf.8.expiration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"duration_seconds":{"type":"integer","minimum":60,"description":"Seconds to wait before the timer fires. Minimum `60`, maximum `31556952` (1 year).","maximum":31556952},"exits":{"type":"boolean","description":"When true, the user exits the journey when the timer fires; when false, the user continues to convergence."}},"description":"Optional expiration timer. `null` waits indefinitely.","uniqueKey":"nodes.items.[INDEX].oneOf.8.expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"nodes.items.[INDEX].oneOf.8.expiration","typeLabel":"object | null"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"nodes.items.[INDEX]","typeLabel":"object"},"description":"Ordered list of journey nodes.","uniqueKey":"nodes","typeLabel":"object[]"},"concurrency_key":{"type":"string","description":"Opaque optimistic-concurrency token. Read-only. Pass it back on update to guard against overwriting a concurrent change (`409 journey-stale`). Send it back exactly as read from this response; do not construct or parse it.","uniqueKey":"concurrency_key","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","app_id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","state":"draft","created_at":"\u003cstring>","updated_at":"\u003cstring>","started_at":"\u003cstring>","archived_at":"\u003cstring>","created_source":"\u003cstring>","audience":{"kind":"segment","included_segment_ids":["\u003cstring>"],"excluded_segment_ids":["\u003cstring>"],"future_additions_only":true},"early_exit":{"rules":{"on_segment":{"included_segment_ids":["\u003cstring>"]},"when_not_in_audience":true,"on_session":true,"on_event":{"name":"\u003cstring>"}},"tag_on_early_exit":{}},"reentry_rules":{"duration_seconds":601},"schedule":{"start_at":"\u003cstring>","stop_at":"\u003cstring>","error":"\u003cstring>"},"nodes":[{"kind":"wait","id":"\u003cstring>","client_node_id":"\u003cstring>","annotation":"\u003cstring>","duration_seconds":15778506}],"concurrency_key":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"39b26eb6-896e-4f58-9e22-8ad2c02252df":{"description":"400","content":{"application/json":{"schema":{"type":"object","description":"Validation error response. Uses the same `code`/`title`/`meta` shape as every other error; the failing field and any positional detail travel in `meta`.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Stable, kebab-case error identifier. Always `invalid-payload` for validation failures.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Human-readable message. Wording may change between releases.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"meta":{"type":"object","description":"Structured context. Always includes `attribute` (the field, or `base` for request-level errors); may also include `path`, `node_id`, or `client_node_id`.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"invalid-payload","title":"the property '#/nodes/1/bogus' is not defined and the schema does not allow additional properties","meta":{"attribute":"base"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"invalid-payload","title":"the property '#/nodes/1/bogus' is not defined and the schema does not allow additional properties","meta":{"attribute":"base"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"75796c00-ae7d-425d-8361-4c77c4d60583":{"description":"403","content":{"application/json":{"schema":{"type":"object","description":"Error response with a stable machine-readable `code`.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Stable, kebab-case error identifier. Does not change once shipped.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Human-readable message. Wording may change between releases.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"meta":{"type":"object","description":"Optional structured context. Shape varies by error.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"journey-not-entitled","title":"Journeys are not enabled for this app","meta":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"journey-not-entitled","title":"Journeys are not enabled for this app","meta":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"69a29fe0-c861-4342-a89f-4b5167139f55":{"description":"404","content":{"application/json":{"schema":{"type":"object","description":"Error response with a stable machine-readable `code`.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Stable, kebab-case error identifier. Does not change once shipped.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Human-readable message. Wording may change between releases.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"meta":{"type":"object","description":"Optional structured context. Shape varies by error.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"journey-node-not-found","title":"Node not found","meta":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"journey-node-not-found","title":"Node not found","meta":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"cd4eeaee-5598-451c-a08d-976e229e75f9":{"description":"409","content":{"application/json":{"schema":{"type":"object","description":"Error response with a stable machine-readable `code`.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Stable, kebab-case error identifier. Does not change once shipped.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Human-readable message. Wording may change between releases.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"meta":{"type":"object","description":"Optional structured context. Shape varies by error.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"journey-stale","title":"Journey has changed since it was last fetched","meta":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"journey-stale","title":"Journey has changed since it was last fetched","meta":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f2720a98-6bcd-4d27-9c36-3d04e1758d63":{"description":"422","content":{"application/json":{"schema":{"type":"object","description":"Error response with a stable machine-readable `code`.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Stable, kebab-case error identifier. Does not change once shipped.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Human-readable message. Wording may change between releases.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"meta":{"type":"object","description":"Optional structured context. Shape varies by error.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"journey-archived","title":"Archived Journeys cannot be edited","meta":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"journey-archived","title":"Archived Journeys cannot be edited","meta":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"232bc4fd-39e2-4a1c-be0b-7561b2ff3cf5":{"description":"Rate limit exceeded. Wait the number of seconds in the `Retry-After` header before retrying.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request. Always emitted on 429 responses.","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"One or more human-readable error messages.","uniqueKey":"errors","typeLabel":"string[]"},"success":{"type":"boolean","description":"Present (and `false`) on some endpoints (notifications, templates, segments). Not emitted by every endpoint.","uniqueKey":"success","typeLabel":"boolean"},"reference":{"type":"array","items":{"type":"string","uniqueKey":"reference.items.[INDEX]","typeLabel":"string"},"description":"Documentation URL fragments related to the error. Only emitted by the API-key auth error helpers.","uniqueKey":"reference","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":["API rate limit exceeded."]},"examples":{"Example":{"title":"Example","value":{"errors":["API rate limit exceeded."]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c673d826-9e50-44e7-be1a-14cb91ce6281":{}},"servers":{"cf753503-cc1a-4f14-8e18-590f517b52c4":{"url":"https://api.onesignal.com"}},"schemas":{"18bb57a4-f1dc-42a4-9f26-73efa2581682":{"oneOf":[{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"wait","description":"Holds the user for a fixed duration before continuing.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"duration_seconds":{"type":"integer","description":"Seconds to hold the user. Minimum `60`, maximum `31556952` (1 year).","minimum":60,"maximum":31556952}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"time_window","description":"Holds the user until the next configured time window opens.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"relative_to":{"type":"string","enum":["schedule_in_timezone","last_active_time"],"description":"`schedule_in_timezone` uses the configured windows; `last_active_time` holds relative to the user's last active time."},"windows":{"type":"array","items":{"type":"object","properties":{"start":{"type":"object","description":"When the window opens.","properties":{"hour":{"type":"integer","minimum":0,"maximum":23,"description":"Hour of day, 0-23."},"minute":{"type":"integer","minimum":0,"maximum":59,"description":"Minute of hour, 0-59. Defaults to 0."}}},"end":{"type":"object","description":"When the window closes.","properties":{"hour":{"type":"integer","minimum":0,"maximum":23,"description":"Hour of day, 0-23."},"minute":{"type":"integer","minimum":0,"maximum":59,"description":"Minute of hour, 0-59. Defaults to 0."}}},"day_of_week":{"type":"integer","minimum":1,"maximum":7,"description":"Day of week, 1 = Monday. Omit to apply the window to every day."}},"description":"A wall-clock window. Each window must span at least 15 minutes."},"description":"One or more time windows. A window with no `day_of_week` applies to every day, and is returned in that same day-agnostic form. Required when `relative_to` is `schedule_in_timezone`; must be omitted when it is `last_active_time`, and is absent from responses for those nodes."},"time_zone":{"type":"string","description":"IANA timezone identifier used when the user's timezone is unavailable."},"use_user_time_zone":{"type":"boolean","description":"When true, uses the user's timezone if available."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","enum":["send_push","send_email","send_sms"],"description":"Sends a message on the given channel using a template.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"template_id":{"type":"string","description":"UUID of the template to send."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"send_iam","description":"Sends an in-app message.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"iam_id":{"type":"string","description":"UUID of the in-app message to send."},"user_ttl_seconds":{"type":"integer","minimum":1,"description":"Optional time-to-live for the in-app message, in seconds."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"send_webhook","description":"Sends a webhook.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"webhook_id":{"type":"string","description":"UUID of the webhook to send."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"tag","description":"Assigns key-value tags to the user.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"assignments":{"type":"object","additionalProperties":{"type":"string"},"description":"Tag key-value pairs to assign. An empty string value removes the tag. Keys are limited to 255 characters and values to 1024."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"split_range","description":"Routes users into weighted branches that converge to the next sibling node.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"randomize_on_entry":{"type":"boolean","description":"When true, assigns each user to a branch at random on entry. Defaults to false."},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only."},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true},"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must belong to."},"excluded_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must not belong to."}}},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel."},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write."},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`."}}},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true},"name":{"type":"string","description":"Event name, up to 255 characters."},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`."}}}}},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."},{"type":"null","description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."}]}}}]},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100."},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node."}}},"description":"Weighted branches. Between 2 and 25. Weights must sum to 100. Order determines display order.","minItems":2,"maxItems":25}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"yes_no","description":"Routes users into a yes or no branch based on a condition.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"branches":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only."},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true},"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must belong to."},"excluded_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must not belong to."}}},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel."},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write."},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`."}}},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true},"name":{"type":"string","description":"Event name, up to 255 characters."},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`."}}}}},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."},{"type":"null","description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."}]}}}]},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100."},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node."}}},"description":"Exactly two branches. The branch with a `condition` is the \"yes\" branch; the branch without one is the \"no\" branch."}}},{"type":"object","description":"A journey node. The `kind` field selects the shape. Branching nodes (`split_range`, `yes_no`, `wait_until`) nest their sub-graphs inline via `branches[].nodes`.","required":["kind"],"properties":{"kind":{"type":"string","const":"wait_until","description":"Holds the user until any branch condition is met, or an optional expiration timer fires.","isRequired":true},"id":{"type":"string","description":"Server-assigned node UUID. Read-only. Returned on reads; sending it on create is rejected with a `400` validation error."},"client_node_id":{"type":"string","description":"Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request (for example as `client_node_id` on an `on_notification_action` condition). Persisted and returned on reads."},"annotation":{"type":"string","description":"Optional free-text label, up to 1024 characters. Stored and returned as-is with no effect on journey behavior."},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned branch identifier. Read-only."},"condition":{"oneOf":[{"type":"object","title":"segment_membership","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"segment_membership","isRequired":true},"included_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must belong to."},"excluded_segment_ids":{"type":"array","items":{"type":"string"},"description":"Segment UUIDs the user must not belong to."}}},{"type":"object","title":"on_notification_action","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"on_notification_action","isRequired":true},"action":{"type":"string","enum":["received","clicked","opened"],"description":"The notification action to branch on. Which actions apply depends on the sending node's channel."},"sending_node_id":{"type":"string","description":"`id` of the sending node this action refers to. Returned on reads; accepted on write."},"client_node_id":{"type":"string","description":"Write-only alternative to `sending_node_id`. References the sending node by its `client_node_id`, which is resolved to that node's `id`."}}},{"type":"object","title":"event_trigger","description":"A branch condition. The `kind` field selects the shape.","required":["kind"],"properties":{"kind":{"type":"string","const":"event_trigger","isRequired":true},"name":{"type":"string","description":"Event name, up to 255 characters."},"attributes":{"type":"array","description":"Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected.","items":{"type":"array","items":{"type":"object","required":["key","operator"],"properties":{"key":{"type":"string","description":"Event attribute key.","isRequired":true},"operator":{"type":"string","enum":["equal","not_equal","less","less_or_equal","greater_or_equal","greater","is","is_not","exists","not_exists","before","after"],"description":"Comparison operator.","isRequired":true},"value":{"type":"string","description":"Value to compare against. Not required for `exists` and `not_exists`."}}}}},"entry_event_match_attributes":{"oneOf":[{"type":"array","items":{"type":"object"},"description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."},{"type":"null","description":"Match incoming event properties against the journey's entry event. Only valid on event-triggered journeys."}]}}}]},"weight":{"type":"number","description":"Branch weight for `split_range` nodes. Weights across a node's branches must sum to 100."},"nodes":{"type":"array","items":{"$circularRef":"18bb57a4-f1dc-42a4-9f26-73efa2581682"},"description":"Nodes run when this branch is taken, before flow converges to the next sibling node."}}},"description":"Condition branches. At least one required, at most 25. Order determines priority.","minItems":1,"maxItems":25},"expiration":{"oneOf":[{"type":"object","description":"Optional expiration timer. `null` waits indefinitely.","properties":{"duration_seconds":{"type":"integer","minimum":60,"description":"Seconds to wait before the timer fires. Minimum `60`, maximum `31556952` (1 year).","maximum":31556952},"exits":{"type":"boolean","description":"When true, the user exits the journey when the timer fires; when false, the user continues to convergence."}}},{"type":"null","description":"Optional expiration timer. `null` waits indefinitely.","properties":{"duration_seconds":{"type":"integer","minimum":60,"description":"Seconds to wait before the timer fires. Minimum `60`, maximum `31556952` (1 year).","maximum":31556952},"exits":{"type":"boolean","description":"When true, the user exits the journey when the timer fires; when false, the user continues to convergence."}}}]}}}]}}},"originalFileLocation":"openapi.json"},"subdomain":"onesignal","siteName":"OneSignal","title":"Update journey node - OneSignal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/update-journey-node","matchLevel":0},"cn":{"href":"/reference/update-journey-node","matchLevel":0},"ko":{"href":"/reference/update-journey-node","matchLevel":0},"ja":{"href":"/reference/update-journey-node","matchLevel":0},"tr":{"href":"/reference/update-journey-node","matchLevel":0},"pt-BR":{"href":"/reference/update-journey-node","matchLevel":0},"es":{"href":"/reference/update-journey-node","matchLevel":0},"fr":{"href":"/reference/update-journey-node","matchLevel":0}}},"lastModified":"2026-08-17T19:46:21.040Z","originalFileLocation":"reference/update-journey-node.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OneSignal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update journey node - OneSignal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OneSignal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.onesignal.com/reference/update-journey-node\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onesignal.mintlify.site/_mintlify/api/og/v2?division=Journeys\u0026amp;title=Update+journey+node\u0026amp;description=Apply+a+partial+update+to+a+single+journey+node%2C+located+by+its+server-assigned+id%2C+with+JSON+Merge+Patch.\u0026amp;theme=8d648f04f85028b307bd669b\u0026amp;signature=fbf34c070826b7ad8ff05f410400aa0e21ed318b771a64fbe0040566bba38066\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update journey node - OneSignal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onesignal.mintlify.site/_mintlify/api/og/v2?division=Journeys\u0026amp;title=Update+journey+node\u0026amp;description=Apply+a+partial+update+to+a+single+journey+node%2C+located+by+its+server-assigned+id%2C+with+JSON+Merge+Patch.\u0026amp;theme=8d648f04f85028b307bd669b\u0026amp;signature=fbf34c070826b7ad8ff05f410400aa0e21ed318b771a64fbe0040566bba38066\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/onesignal/eCiRydtW5fLfLRWp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OneSignal Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3A3DB3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://documentation.onesignal.com/reference/update-journey-node\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/update-journey-node.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://documentation.onesignal.com/#organization\",\"name\":\"OneSignal\",\"url\":\"https://documentation.onesignal.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onesignal/yJcueeDCO7UpHnnY/logo/OneSignal-Logo.svg?fit=max\u0026auto=format\u0026n=yJcueeDCO7UpHnnY\u0026q=85\u0026s=1fcfb6fef6d820fd9d99c74850711107\"}},{\"@type\":\"WebSite\",\"@id\":\"https://documentation.onesignal.com#website\",\"name\":\"OneSignal\",\"url\":\"https://documentation.onesignal.com\",\"publisher\":{\"@id\":\"https://documentation.onesignal.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://documentation.onesignal.com/reference/update-journey-node#webpage\",\"url\":\"https://documentation.onesignal.com/reference/update-journey-node\",\"name\":\"Update journey node\",\"description\":\"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\",\"dateModified\":\"2026-08-17T19:46:21.040Z\",\"isPartOf\":{\"@id\":\"https://documentation.onesignal.com#website\"},\"breadcrumb\":{\"@id\":\"https://documentation.onesignal.com/reference/update-journey-node#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://documentation.onesignal.com/reference/update-journey-node#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://documentation.onesignal.com/reference/create-message\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Journeys\",\"item\":\"https://documentation.onesignal.com/reference/view-journeys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update journey node\",\"item\":\"https://documentation.onesignal.com/reference/update-journey-node\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://documentation.onesignal.com/reference/update-journey-node#apireference\",\"headline\":\"Update journey node\",\"name\":\"Update journey node\",\"description\":\"Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch.\",\"url\":\"https://documentation.onesignal.com/reference/update-journey-node\",\"mainEntityOfPage\":{\"@id\":\"https://documentation.onesignal.com/reference/update-journey-node#webpage\"},\"dateModified\":\"2026-08-17T19:46:21.040Z\",\"keywords\":\"journeys API, journey nodes, journey automation, json merge patch, journey-node-not-found\",\"publisher\":{\"@id\":\"https://documentation.onesignal.com/#organization\"},\"isPartOf\":{\"@id\":\"https://documentation.onesignal.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OneSignal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OneSignal","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/docs/en/home"}]},{"tab":"User Guides","pages":[{"title":"User Guides","href":"/docs/en/quickstart-guide"}]},{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":"/docs/en/developers"}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/docs/en/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Server SDK reference","href":"/docs/en/server-sdk-reference"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Organization","pages":[{"title":"List audit logs","openapi":"GET /organizations/{organization_id}/audit_logs","href":"/reference/list-audit-logs"},{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"},{"title":"Email reputation statistics","openapi":"GET /apps/{app_id}/email_analytics/delivery_metrics","href":"/reference/delivery-metrics"},{"title":"Email provider metrics","openapi":"GET /apps/{app_id}/email_analytics/provider_metrics","href":"/reference/provider-metrics"},{"title":"Email provider metrics timeseries","openapi":"GET /apps/{app_id}/email_analytics/provider_metrics_timeseries","href":"/reference/provider-metrics-timeseries"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]},{"tab":"Customer Success Hub","pages":[{"title":"Customer Success Hub","href":"/docs/en/customer-success-hub"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"cn","tabs":[{"tab":"主页","pages":[{"title":"主页","href":"/docs/cn/home"}]},{"tab":"用户指南","pages":[{"title":"用户指南","href":"/docs/cn/quickstart-guide"}]},{"tab":"开发者指南","pages":[{"title":"开发者指南","href":"/docs/cn/developers"}]},{"tab":"教程","pages":[{"title":"教程","href":"/docs/cn/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API Reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"服务器 SDK 参考","href":"/docs/cn/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"ko","tabs":[{"tab":"홈","pages":[{"title":"홈","href":"/docs/ko/home"}]},{"tab":"사용자 가이드","pages":[{"title":"사용자 가이드","href":"/docs/ko/quickstart-guide"}]},{"tab":"개발자 가이드","pages":[{"title":"개발자 가이드","href":"/docs/ko/developers"}]},{"tab":"튜토리얼","pages":[{"title":"튜토리얼","href":"/docs/ko/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Server SDK 참조","href":"/docs/ko/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"ja","tabs":[{"tab":"ホームページ","pages":[{"title":"ホームページ","href":"/docs/ja/home"}]},{"tab":"ユーザーガイド","pages":[{"title":"ユーザーガイド","href":"/docs/ja/quickstart-guide"}]},{"tab":"開発者ガイド","pages":[{"title":"開発者ガイド","href":"/docs/ja/developers"}]},{"tab":"チュートリアル","pages":[{"title":"チュートリアル","href":"/docs/ja/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Server SDK reference","href":"/docs/en/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"tr","tabs":[{"tab":"Ana Sayfa","pages":[{"title":"Ana Sayfa","href":"/docs/tr/home"}]},{"tab":"Kullanıcı Kılavuzları","pages":[{"title":"Kullanıcı Kılavuzları","href":"/docs/tr/quickstart-guide"}]},{"tab":"Geliştirici Kılavuzları","pages":[{"title":"Geliştirici Kılavuzları","href":"/docs/tr/developers"}]},{"tab":"Eğitimler","pages":[{"title":"Eğitimler","href":"/docs/tr/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Server SDK reference","href":"/docs/en/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"pt-BR","tabs":[{"tab":"Início","pages":[{"title":"Início","href":"/docs/pt-BR/home"}]},{"tab":"Guia do Usuário","pages":[{"title":"Guia do Usuário","href":"/docs/pt-BR/quickstart-guide"}]},{"tab":"Guia de desenvolvedor","pages":[{"title":"Guia de desenvolvedor","href":"/docs/pt-BR/developers"}]},{"tab":"Tutoriais","pages":[{"title":"Tutoriais","href":"/docs/pt-BR/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Referência do SDK do Servidor","href":"/docs/pt-BR/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"es","tabs":[{"tab":"Inicio","pages":[{"title":"Inicio","href":"/docs/es/home"}]},{"tab":"Guías del Usuario","pages":[{"title":"Guías del Usuario","href":"/docs/es/quickstart-guide"}]},{"tab":"Guías del desarrollador","pages":[{"title":"Guías del desarrollador","href":"/docs/es/developers"}]},{"tab":"Tutoriales","pages":[{"title":"Tutoriales","href":"/docs/es/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Server SDK reference","href":"/docs/en/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}},{"language":"fr","tabs":[{"tab":"Accueil","pages":[{"title":"Accueil","href":"/docs/fr/home"}]},{"tab":"Guides utilisateur","pages":[{"title":"Guides utilisateur","href":"/docs/fr/quickstart-guide"}]},{"tab":"Guides développeur","pages":[{"title":"Guides développeur","href":"/docs/fr/developers"}]},{"tab":"Tutoriels","pages":[{"title":"Tutoriels","href":"/docs/fr/tutorials"}]},{"tab":"API Reference","groups":[{"group":"Using the REST APIs","pages":[{"title":"REST API overview","href":"/reference/rest-api-overview"},{"title":"Rate limits and error handling","href":"/reference/rate-limits"}]},{"group":"API reference","pages":[{"group":"Messages","pages":[{"title":"Sending messages with the OneSignal API","href":"/reference/create-message"},{"title":"Idempotent API requests","href":"/reference/idempotent-notification-requests"},{"title":"Push notification","openapi":"POST /notifications?c=push","href":"/reference/push-notification"},{"title":"Email","openapi":"POST /notifications?c=email","href":"/reference/email"},{"title":"SMS","openapi":"POST /notifications?c=sms","href":"/reference/sms"},{"title":"View message","openapi":"GET /notifications/{message_id}?app_id={app_id}","href":"/reference/view-message"},{"title":"View messages","openapi":"GET /notifications?app_id={app_id}\u0026limit={limit}\u0026offset={offset}\u0026kind={kind}\u0026template_id={template_id}\u0026time_offset={time_offset}","href":"/reference/view-messages"},{"title":"Cancel message","openapi":"DELETE /notifications/{message_id}?app_id={app_id}","href":"/reference/cancel-message"},{"title":"Message history","openapi":"POST /notifications/{message_id}/history","href":"/reference/message-history"},{"title":"Estimated recipients","openapi":"POST /notifications/count-unsaved","href":"/reference/count-unsaved"}]},{"group":"Live Activities","pages":[{"title":"Start Live Activity","openapi":"POST /apps/{app_id}/activities/activity/{activity_type}","href":"/reference/start-live-activity"},{"title":"Update Live Activity","openapi":"POST /apps/{app_id}/live_activities/{activity_id}/notifications","href":"/reference/update-live-activity-api"}]},{"group":"Custom Events","pages":[{"title":"Create custom events","openapi":"POST /apps/{app_id}/custom_events","href":"/reference/create-custom-events"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /apps/{app_id}/users","href":"/reference/create-user"},{"title":"View user","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/view-user"},{"title":"Update user","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/update-user"},{"title":"Delete user","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}","href":"/reference/delete-user"},{"title":"View user identity","openapi":"GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/fetch-aliases"},{"title":"View user identity (by subscription)","openapi":"GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/fetch-identity-by-subscription"},{"title":"Create or update alias","openapi":"PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity","href":"/reference/create-alias"},{"title":"Create alias (by subscription)","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity","href":"/reference/create-alias-by-subscription"},{"title":"Delete alias","openapi":"DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}","href":"/reference/delete-alias"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription by alias","openapi":"POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions","href":"/reference/create-subscription"},{"title":"Update Subscription by ID","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/update-subscription"},{"title":"Update Subscription by token","openapi":"PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}","href":"/reference/update-subscription-by-token"},{"title":"Delete Subscription","openapi":"DELETE /apps/{app_id}/subscriptions/{subscription_id}","href":"/reference/delete-subscription"},{"title":"Transfer Subscription","openapi":"PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner","href":"/reference/transfer-subscription"},{"title":"Unsubscribe email with token","openapi":"POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token}","href":"/reference/unsubscribe-with-token"}]},{"group":"Templates","pages":[{"title":"Create template","openapi":"POST /templates","href":"/reference/create-template"},{"title":"Update template","openapi":"PATCH /templates/{template_id}?app_id={app_id}","href":"/reference/update-template"},{"title":"View templates","openapi":"GET /templates?app_id={app_id}\u0026limit={limit}\u0026offset={offset}","href":"/reference/view-templates"},{"title":"View template","openapi":"GET /templates/{template_id}?app_id={app_id}","href":"/reference/view-template"},{"title":"Delete template","openapi":"DELETE /templates/{template_id}?app_id={app_id}","href":"/reference/delete-template"},{"title":"Copy template to another app","openapi":"POST /templates/{template_id}/copy_to_app?app_id={app_id}","href":"/reference/copy-template-to-another-app"}]},{"group":"Segments","pages":[{"title":"View segments","openapi":"GET /apps/{app_id}/segments","href":"/reference/view-segments"},{"title":"View segment","openapi":"GET /apps/{app_id}/segments/{segment_id}","href":"/reference/view-segment"},{"title":"Create segment","openapi":"POST /apps/{app_id}/segments","href":"/reference/create-segments"},{"title":"Update segment","openapi":"PATCH /apps/{app_id}/segments/{segment_id}","href":"/reference/update-segment"},{"title":"Delete segment","openapi":"DELETE /apps/{app_id}/segments/{segment_id}","href":"/reference/delete-segments"}]},{"group":"Journeys","pages":[{"title":"View journeys","tag":"BETA","openapi":"GET /apps/{app_id}/journeys","href":"/reference/view-journeys"},{"title":"View journey","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}","href":"/reference/view-journey"},{"title":"View journey stats","tag":"BETA","openapi":"GET /apps/{app_id}/journeys/{id}/stats","href":"/reference/view-journey-stats"},{"title":"Create journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys","href":"/reference/create-journey"},{"title":"Duplicate journey","tag":"BETA","openapi":"POST /apps/{app_id}/journeys/{id}/duplicate","href":"/reference/duplicate-journey"},{"title":"Update journey","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}","description":"Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state.","href":"/reference/update-journey"},{"title":"Update journey node","tag":"BETA","openapi":"PATCH /apps/{app_id}/journeys/{id}/nodes/{node_id}","href":"/reference/update-journey-node"},{"title":"Delete journey","tag":"BETA","openapi":"DELETE /apps/{app_id}/journeys/{id}","description":"Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.","href":"/reference/delete-journey"}]},{"group":"Configuration","pages":[{"title":"View apps","openapi":"GET /apps","href":"/reference/view-apps"},{"title":"View an app","openapi":"GET /apps/{app_id}","href":"/reference/view-an-app"},{"title":"Create an app","openapi":"POST /apps","href":"/reference/create-an-app"},{"title":"Update an app","openapi":"PUT /apps/{app_id}","href":"/reference/update-an-app"},{"title":"View API keys","openapi":"GET /apps/{app_id}/auth/tokens","href":"/reference/view-api-keys"},{"title":"Create API key","openapi":"POST /apps/{app_id}/auth/tokens","href":"/reference/create-api-key"},{"title":"Delete API key","openapi":"DELETE /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/delete-api-key"},{"title":"Update API key","openapi":"PATCH /apps/{app_id}/auth/tokens/{token_id}","href":"/reference/update-api-key"},{"title":"Rotate API key","openapi":"POST /apps/{app_id}/auth/tokens/{token_id}/rotate","href":"/reference/rotate-api-key"}]},{"group":"Analytics","pages":[{"title":"Export subscriptions CSV","openapi":"POST /players/csv_export","href":"/reference/csv-export"},{"title":"Export audience activity CSV","openapi":"POST /notifications/{message_id}/export_events","href":"/reference/export-csv-of-events"},{"title":"View outcomes","openapi":"GET /apps/{app_id}/outcomes?outcome_names={outcome_names}\u0026outcome_time_range={outcome_time_range}\u0026outcome_platforms={outcome_platforms}\u0026outcome_attribution={outcome_attribution}","href":"/reference/view-outcomes"}]},{"group":"Deprecated","pages":[{"title":"View players","deprecated":true,"href":"/reference/view-devices"},{"title":"View player","deprecated":true,"href":"/reference/view-device"},{"title":"Add a player","deprecated":true,"href":"/reference/add-a-device"},{"title":"Edit player","deprecated":true,"href":"/reference/edit-device"},{"title":"Edit tags with external user id","deprecated":true,"href":"/reference/edit-tags-with-external-user-id"},{"title":"Delete player record","deprecated":true,"href":"/reference/delete-user-record"}]}]},{"group":"SDKs","pages":[{"title":"Référence du SDK Serveur","href":"/docs/fr/server-sdk-reference"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://onesignal.com/blog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OneSignal"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@onesignalofficial/playlists"}]}}]},"basePath":"","title":"Update journey node - OneSignal","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}