Journey

Represents a customer journey in Marketing Cloud. A journey defines an automated workflow that guides contacts through a series of marketing interactions across channels.

AutomationCustomer JourneyDigital MarketingEmailMarketingPersonalization

Properties

Name Type Description
id string System-generated unique identifier for the journey
key string Customer-defined unique key for the journey
name string Display name of the journey
description string Description of the journey purpose
version integer Current version number of the journey
status string Current status of the journey
createdDate string
modifiedDate string
workflowApiVersion number Version of the Journey Builder API used
triggers array Entry triggers that inject contacts into the journey
activities array Activities that contacts pass through in the journey
goals array Goal criteria that measure journey success
exits array Exit criteria that remove contacts from the journey
stats object Runtime statistics for the journey
View JSON Schema on GitHub

JSON Schema

salesforce-marketing-cloud-journey-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Journey",
  "type": "object",
  "description": "Represents a customer journey in Marketing Cloud. A journey defines an automated workflow that guides contacts through a series of marketing interactions across channels.",
  "properties": {
    "id": {
      "type": "string",
      "description": "System-generated unique identifier for the journey"
    },
    "key": {
      "type": "string",
      "description": "Customer-defined unique key for the journey"
    },
    "name": {
      "type": "string",
      "description": "Display name of the journey"
    },
    "description": {
      "type": "string",
      "description": "Description of the journey purpose"
    },
    "version": {
      "type": "integer",
      "description": "Current version number of the journey"
    },
    "status": {
      "type": "string",
      "description": "Current status of the journey"
    },
    "createdDate": {
      "type": "string"
    },
    "modifiedDate": {
      "type": "string"
    },
    "workflowApiVersion": {
      "type": "number",
      "description": "Version of the Journey Builder API used"
    },
    "triggers": {
      "type": "array",
      "description": "Entry triggers that inject contacts into the journey"
    },
    "activities": {
      "type": "array",
      "description": "Activities that contacts pass through in the journey"
    },
    "goals": {
      "type": "array",
      "description": "Goal criteria that measure journey success"
    },
    "exits": {
      "type": "array",
      "description": "Exit criteria that remove contacts from the journey"
    },
    "stats": {
      "type": "object",
      "description": "Runtime statistics for the journey"
    }
  }
}