Journeys

createJourney

Create a Journey

post/v1/journey/configuration

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

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)",
  "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

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

revisionsnumber required

featureFlagsobject

Example response

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

Changes

Changed in 4 of the 6 revisions of this API.3413

Aug 26, 2026802039ced95324See the full diff
- ▲
  response property allOf[JourneyCreationRequest]/validationRules/additionalProperties/oneOf[RuleRef]/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 201
  response-property-list-of-types-widened
- ▲
  added subschema #2 to the allOf[JourneyCreationRequest]/validationRules/additionalProperties/ response property oneOf list for the response status 201
  response-property-one-of-added
- ○
  added the new optional request property settings/authGate
  new-optional-request-property
- ○
  request property validationRules/additionalProperties/oneOf[RuleRef]/additionalProperties/ list-of-types was widened by adding types array to media type application/json
  request-property-list-of-types-widened
- ○
  added subschema #2 to the validationRules/additionalProperties/ request property oneOf list
  request-property-one-of-added
- ○
  added the optional property allOf[JourneyCreationRequest]/settings/authGate to the response with the 201 status
  response-optional-property-added
Aug 20, 2026d19cdc961b842See the full diff
- ○
  added the new optional request property steps/items/stepperType
  new-optional-request-property
- ○
  added the optional property allOf[JourneyCreationRequest]/steps/items/stepperType to the response with the 201 status
  response-optional-property-added
Jul 31, 2026515acb1f892e46See the full diff
- ●
  removed the request property settings/savingProgress/savingMode
  request-property-removed
- ●
  removed the request property settings/savingProgress/supportedVersion
  request-property-removed
- ●
  removed the optional property allOf[JourneyCreationRequest]/settings/savingProgress/savingMode from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property allOf[JourneyCreationRequest]/settings/savingProgress/supportedVersion from the response with the 201 status
  response-optional-property-removed
- ○
  added the new optional request property contextSchema/items/description
  new-optional-request-property
- ○
  added the new optional request property settings/savingProgress/mode
  new-optional-request-property
- ○
  added the new optional request property settings/savingProgress/supportedRevision
  new-optional-request-property
- ○
  added the optional property allOf[JourneyCreationRequest]/contextSchema/items/description to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[JourneyCreationRequest]/settings/savingProgress/mode to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[JourneyCreationRequest]/settings/savingProgress/supportedRevision to the response with the 201 status
  response-optional-property-added
Jul 21, 20268927efbc8b6d11See the full diff
- ▲
  the response property allOf[JourneyCreationRequest]/settings/templateId became nullable for the status 201
  response-property-became-nullable
- ○
  the request property settings/templateId became nullable
  request-property-became-nullable

Full history