Journeys V2

APIs related to Limio JourneysV2

Get Journeys V2

get

Retrieves all the journeysV2 in the Catalog

Authorizations

ApiKeybearerAuth

AuthorizationstringRequired

This authentication method is applicable to specific operations.

To create a publishable API key, see Public Keys (Read-Only API).

Responses

200

OK

application/json

starting_pointstringOptional

The starting point of the journey

Example: /cancel-now/

fallback_tagstringOptional

The fallback tag for the journey

Example: /cancel/

401

Unauthorized

application/json

404

Journey not found

application/json

get

/v2/journey

HTTPcURLJavaScriptPython

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

{
  "starting_point": "/cancel-now/",
  "fallback_tag": "/cancel/",
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Add Journey V2

post

Adds a new journey in the Catalog

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Body

application/json

namestringOptional

The name of the journey

Example: Test

Responses

200

OK

application/json

messagestringOptionalDefault: Journey added successfully

401

Unauthorized

application/json

409

Conflict

application/json

post

/v2/journey

HTTPcURLJavaScriptPython

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 added successfully"
}

Get Journey V2 by name

get

Get a journey by name

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

journeyNamestringRequired

The name of the journey to retrieve

Responses

200

OK

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

application/json

404

Journey not found

application/json

get

/v2/journey/{journeyName}

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

journeyNamestringOptional

The name of the journey to update.

Example: Digital Journey

Body

application/json

namestringRequired

Name of the journey.

Example: test001

Responses

200

OK

application/json

namestringRequired

Name of the journey.

Example: test001

401

Unauthorized

application/json

put

/v2/journey/{journeyName}

HTTPcURLJavaScriptPython

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"
    ]
  }
}

{
  "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"
    ]
  }
}

Delete JourneyV2 by name

delete

Delete a journey by name

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

journeyNamestringRequired

The name of the journey to delete

Responses

200

Successfully deleted

application/json

messagestringOptionalDefault: Journey deleted successfully

401

Unauthorized

application/json

404

Journey not found

application/json

delete

/v2/journey/{journeyName}

HTTPcURLJavaScriptPython

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

{
  "message": "Journey deleted successfully"
}