Journeys V2

APIs related to Limio JourneysV2

Get Journeys V2

Retrieves all the journeysV2 in the Catalog

SecurityApiKey or bearerAuth
Responses
200

OK

401

Unauthorized

404

Journey not found

get/v2/journey
Request samples
Response samples
application/json
{
  • "starting_point": "/cancel-now/",
  • "fallback_tag": "/cancel/",
  • "journeys": [
    ]
}

Add Journey V2

Adds a new journey in the Catalog

SecuritybearerAuth
Request
Request Body schema: application/json
required
name
string

The name of the journey

Responses
200

OK

401

Unauthorized

409

Conflict

post/v2/journey
Request samples
application/json
{
  • "name": "Test"
}
Response samples
application/json
{
  • "message": "Journey added successfully"
}

Get Journey V2 by name

Get a journey by name

SecuritybearerAuth
Request
path Parameters
journeyName
required
string

The name of the journey to retrieve

Responses
200

OK

401

Unauthorized

404

Journey not found

get/v2/journey/{journeyName}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "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"
}

Delete JourneyV2 by name

Delete a journey by name

SecuritybearerAuth
Request
path Parameters
journeyName
required
string

The name of the journey to delete

Responses
200

Successfully deleted

401

Unauthorized

404

Journey not found

delete/v2/journey/{journeyName}
Request samples
Response samples
application/json
{
  • "message": "Journey deleted successfully"
}

Update or Create Journey V2

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.

SecuritybearerAuth
Request
path Parameters
journeyName
string

The name of the journey to update.

Example: Digital Journey
Request Body schema: application/json
required
name
required
string

Name of the journey.

required
object

Journey conditions to be added.

required
Array of objects

A list of journeys to be updated.

Array
id
required
string <uuid>

Unique identifier for the journey.

Array of objects

List of conditions to be evaluated for the journey.

Array of objects

List of actions to be executed for the journey.

starting_point
string

Optional starting point of the journey.

fallback_tag
string

Optional fallback tag.

domains
Array of strings

Optional list of domains related to the journey.

Responses
200

OK

401

Unauthorized

put/v2/journey/{journeyName}
Request samples
application/json
{
  • "name": "test001",
  • "data": {
    }
}
Response samples
application/json
{
  • "name": "test001",
  • "data": {
    }
}