EPepilot
Journeys

createJourney

Changed on

Create a Journey

post/v1/journey/configuration

Request

  • Base URL
    https://journey-config.sls.epilot.io
  • URL
    https://journey-config.sls.epilot.io/v1/journey/configuration
  • Auth
    HTTP bearer

Query parameters

skipAutomationstring Yn
Example:true

skip creating an Automation (it takes Yn format "true, yes, 1, y")

Request body

journeyIdstring
organizationIdstring required
brandIdstring
namestring required
logicsV4object
journey_typestring

Journey Template

protectedboolean

If true, journey is displayed in read-only mode

protectedEditablestring[]

Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).

validationRulesValidationRuleRef

References to validation rules organized by blocks and fields. Maps block IDs to either one or more ordered rule IDs (for block-level rules) or rule references (for field-level rules).

_manifeststring[]

Manifest/Blueprint ID used to create/update the entity

blueprint_customizationobject

Blueprint field-locking contract (server-managed). Carries the author plane (locks, default level) and the org plane (server-derived overlay). Public writes never persist client-supplied values — the stored contract is authoritative; it is written only by the Blueprints install pipeline.

createdBystring
updatedBystring nullable
__lastModifiedAtstring nullable

If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey

Example request

{
  "journey_type": "Sales template (Premium)",
  "settings": {
    "embedOptions": {
      "lang": "de"
    },
    "offline": {
      "packTtlHours": 24
    }
  },
  "validationRules": {
    "block1": "rule123",
    "block2": [
      "rule456",
      "rule789"
    ],
    "block3": {
      "field1": "rule101",
      "field2": [
        "rule102",
        "rule103"
      ]
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Success

journeyIdstring
organizationIdstring required
brandIdstring
namestring required
logicsV4object
journey_typestring

Journey Template

protectedboolean

If true, journey is displayed in read-only mode

protectedEditablestring[]

Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).

validationRulesValidationRuleRef

References to validation rules organized by blocks and fields. Maps block IDs to either one or more ordered rule IDs (for block-level rules) or rule references (for field-level rules).

_manifeststring[]

Manifest/Blueprint ID used to create/update the entity

blueprint_customizationobject

Blueprint field-locking contract (server-managed). Carries the author plane (locks, default level) and the org plane (server-derived overlay). Public writes never persist client-supplied values — the stored contract is authoritative; it is written only by the Blueprints install pipeline.

createdBystring
updatedBystring nullable
__lastModifiedAtstring nullable

If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey

createdAtstring required
lastModifiedAtstring required
deletedAtstring
versionnumber required

Revision row number of this item. 0 is the journey record, the published version.

revisionsnumber required

Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on PUT, by submissions (journey_context.journey_revision) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via publish-state.

featureFlagsobject

Example response

{
  "journey_type": "Sales template (Premium)",
  "settings": {
    "embedOptions": {
      "lang": "de"
    },
    "offline": {
      "packTtlHours": 24
    }
  },
  "validationRules": {
    "block1": "rule123",
    "block2": [
      "rule456",
      "rule789"
    ],
    "block3": {
      "field1": "rule101",
      "field2": [
        "rule102",
        "rule103"
      ]
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes

  • 2f11eabb1f37Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property /

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • c1595d30cd4fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status