Journeys V2

Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows.

Get Journeys V2

get

Retrieves all the journeysV2 in the Catalog as a paged listing. When no journeys exist, returns 200 with an empty items array.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

queryMorestringOptional

Pagination token from the queryMore field of a previous response. Omit to fetch the first page.

Responses

200

application/json

queryMorestring · nullableOptional

Pagination token. Pass it as the queryMore query parameter to fetch the next page. Null or absent when there are no more pages.

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/v2/journey

GET /api/v2/journey HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "journey-678",
      "record_type": "journey",
      "status": "active",
      "data": {
        "starting_point": "/cancel-now/",
        "fallback_tag": "/cancel/",
        "version_date": "text",
        "journeys": [
          {
            "id": "0dd1b0b0-22b1-400e-8590-301aabd50a69",
            "conditions": [
              {
                "id": "c10cb349-e06a-4a13-bd87-edb40aae77dc",
                "type": "segment",
                "value": "/segments/123abc"
              }
            ],
            "actions": [
              {
                "id": "a9e2204a-8fa0-4d17-83cc-1f6c0838daaf",
                "type": "destination",
                "values": [
                  {
                    "id": "a5113403-7e7d-4c46-9d08-13d79e9df9d1",
                    "tag": "/tags/cancel-discount",
                    "split": "100"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "queryMore": null
}

Add Journey V2

post

Adds a journey to the catalog. GET /api/v2/journey lists the journeys that already exist.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body

namestringOptional

The name of the journey

Example: Test

Responses

200

application/json

messagestringOptionalDefault: Journey created successfully

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

409

Conflict

application/json

post/v2/journey

POST /api/v2/journey HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "Test"
}

{
  "message": "Journey created successfully"
}

Get Journey V2 by name

get

Returns one journey. If you do not know the name, GET /api/v2/journey lists every journey.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

journeyNamestringRequired

The name of the journey to retrieve

Responses

200

application/json

statusstringOptional

The status of the journey record

Example: active

record_typestringOptional

The type of record

Example: journey

idstringOptional

The unique ID of the journey record

Example: journey-678

servicestringOptional

The service the journey belongs to

Example: limio

createdstring · date-timeOptional

Timestamp when the record was created

Example: 2025-03-06T14:25:01.064Z

updatedstring · date-timeOptional

Timestamp when the record was last updated

Example: 2025-03-06T14:25:01.064Z

modestringOptional

The environment or mode the journey is in

Example: production

process_hashstringOptional

The hash used for processing the journey

Example: journey-678

versionstringOptional

The version hash of the journey

Example: c37254b0e5d43c52ca5da66367261b8c57148d63

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Journey not found

application/json

get/v2/journey/{journeyName}

GET /api/v2/journey/{journeyName} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "version_date": "2025-03-06T14:25:01.064Z",
    "journeys": [
      {
        "id": "17c99708-7d9e-4a52-9b95-5b3c456b4e4f",
        "conditions": [],
        "actions": []
      }
    ],
    "starting_point": ""
  },
  "status": "active",
  "record_type": "journey",
  "id": "journey-678",
  "service": "limio",
  "created": "2025-03-06T14:25:01.064Z",
  "updated": "2025-03-06T14:25:01.064Z",
  "mode": "production",
  "process_hash": "journey-678",
  "version": "c37254b0e5d43c52ca5da66367261b8c57148d63"
}

Update or Create Journey V2

put

Updates an existing Journey V2 with the provided data, identified by the journeyName path parameter. If no Journey V2 with the specified journeyName exists, a new one will be created.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

journeyNamestringRequired

The unique name of the journey.

Example: Digital Journey

Body

namestringRequired

Name of the journey.

Example: test001

Responses

200

application/json

The newly created version of the journey record. The API stores every update as a new version and returns the full versioned record, not an echo of the request body.

idstringOptional

The unique ID of the journey record, derived from the journey name.

Example: journey-test001

record_typestringOptional

The type of record.

Example: journey

servicestringOptional

The service the journey belongs to.

Example: limio

statusstringOptional

The status of the journey record.

Example: active

namestringOptional

The starting point submitted in the request body, not the journey name from the path.

Example: /

modestringOptional

The environment or mode the journey is in.

Example: production

createdstring · date-timeOptional

Timestamp when this version was created.

Example: 2025-03-06T14:25:01.064Z

updatedstring · date-timeOptional

Timestamp when this version was last updated.

Example: 2025-03-06T14:25:01.064Z

versionstringOptional

The identifier of this version of the journey.

Example: v01JNMS3CD8YV3E5QW0XK1T9GRD

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

put/v2/journey/{journeyName}

PUT /api/v2/journey/{journeyName} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "name": "test001",
  "data": {
    "journeys": [
      {
        "id": "3f16d308-15f7-4185-874e-5ab2ec0eb644",
        "conditions": [
          {
            "id": "64ef0c29-893a-44de-ba2b-2f3e793a9fc2",
            "type": "country",
            "value": [
              "example_value"
            ]
          }
        ],
        "actions": [
          {
            "id": "e98094b3-23f8-487d-b0fe-05526940767c",
            "type": "destination",
            "values": [
              {
                "id": "ceb9fab6-2ba7-45b2-b199-43f2f40f9cc5",
                "tag": "/",
                "split": "100"
              }
            ]
          }
        ]
      }
    ],
    "starting_point": "/",
    "fallback_tag": "",
    "domains": [
      "example.com",
      "example.org"
    ]
  }
}

{
  "id": "journey-test001",
  "record_type": "journey",
  "service": "limio",
  "status": "active",
  "name": "/",
  "data": {
    "id": "journey-test001",
    "journeys": [
      {}
    ],
    "starting_point": "/",
    "fallback_tag": "",
    "domains": [
      "example.com",
      "example.org"
    ]
  },
  "mode": "production",
  "created": "2025-03-06T14:25:01.064Z",
  "updated": "2025-03-06T14:25:01.064Z",
  "version": "v01JNMS3CD8YV3E5QW0XK1T9GRD"
}

Delete JourneyV2 by name

delete

Deletes one journey. If you do not know the name, GET /api/v2/journey lists every journey.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

journeyNamestringRequired

The name of the journey to delete

Responses

200

Successfully deleted

application/json

messagestringOptionalDefault: Journey group deleted successfully

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Journey not found

application/json

delete/v2/journey/{journeyName}

DELETE /api/v2/journey/{journeyName} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Journey group deleted successfully"
}

PreviousJourneys API

NextSession API

Last updated 6 days ago

Was this helpful?