v3

latestOpenAPI 3.0.02026-07-31162156.9 KB

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 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": {
      "field1": "rule456",
      "field2": "rule789"
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Success