Journeys

The API calls detailed on this page are compatible with Octeth's most recent authorization method. You can include the SessionID or APIKey parameter within the JSON request body.

Create a Journey

Create a Journey

POST https://octeth.mydomain.com/api/v1/journey

Use this API command to create a new journey. The created journey will be set as Disabled by default and trigger mode will be set to Manual.

Request Body

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
Name*	String	Name of the journey.

200: OK On Success

{
    "JourneyID": 5,
    "Journey": {
        "JourneyID": "5",
        "RelUserID": "1",
        "JourneyName": "Test",
        "Trigger": "Manual",
        "TriggerParameters": [],
        "Status": "Disabled",
        "CreatedAt": "2023-08-11 17:19:34",
        "UpdatedAt": "2023-08-11 17:19:34"
    }
}

422: Unprocessable Entity Validation Error

Journey List

Journey List

GET https://octeth.mydomain.com/api/v1journeys

This API request will yield a list of journeys established within the specified user account.

Query Parameters

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.

200: OK On Success

{
    "Journeys": [
        {
            "JourneyID": "5",
            "RelUserID": "1",
            "JourneyName": "Test",
            "Trigger": "Manual",
            "TriggerParameters": "[]",
            "Status": "Disabled",
            "CreatedAt": "2023-08-11 17:19:34",
            "UpdatedAt": "2023-08-11 17:19:34",
            "JourneyStats": {
                "ActiveSubscribers": "0",
                "TotalSubscribers": "0"
            }
        }
    ]
}

Delete a Journey

Delete a Journey

DELETE https://octeth.mydomain.com/api/v1journey

This API call will remove the specific journey that corresponds to the JourneyID parameter.

Query Parameters

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	Integer	The ID number of the journey that needs to be deleted.

200: OK On Success

{
    "JourneyID": "5"
}

422: Unprocessable Entity Validation Error

404: Not Found Journey Not Found

Retrieve a Journey

Delete a Journey

GET https://octeth.mydomain.com/api/v1journey

This API call will remove the specific journey that corresponds to the JourneyID parameter.

Query Parameters

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	Integer	The ID number of the journey that needs to be deleted.

200: OK On Success

{
    "Journey": {
        "JourneyID": "6",
        "RelUserID": "1",
        "JourneyName": "Test",
        "Trigger": "Manual",
        "TriggerParameters": [],
        "Status": "Disabled",
        "CreatedAt": "2023-08-11 18:13:17",
        "UpdatedAt": "2023-08-11 18:13:17"
    }
}

422: Unprocessable Entity Validation Error

404: Not Found Journey Not Found

Change Journey Status

Enable a Journey

GET https://octeth.mydomain.com/api/v1journey.enable

This API call will transition a journey from a Disabled status to an Enabled status.

Query Parameters

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	Integer	The ID number of the journey that needs to be deleted.

200: OK On Success

{
    "Journey": {
        "JourneyID": "6",
        "RelUserID": "1",
        "JourneyName": "Test",
        "Trigger": "Manual",
        "TriggerParameters": [],
        "Status": "Enabled",
        "CreatedAt": "2023-08-11 18:13:17",
        "UpdatedAt": "2023-08-11 18:13:17"
    }
}

422: Unprocessable Entity Validation Error

404: Not Found Journey Not Found

409: Conflict Invalid Journey Status

Disable a Journey

GET https://octeth.mydomain.com/api/v1journey.disable

This API call will transition a journey from a Enabled status to an Disabled status.

Query Parameters

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	Integer	The ID number of the journey that needs to be deleted.

200: OK On Success

{
    "Journey": {
        "JourneyID": "6",
        "RelUserID": "1",
        "JourneyName": "Test",
        "Trigger": "Manual",
        "TriggerParameters": [],
        "Status": "Disabled",
        "CreatedAt": "2023-08-11 18:13:17",
        "UpdatedAt": "2023-08-11 18:13:17"
    }
}

422: Unprocessable Entity Validation Error

404: Not Found Journey Not Found

409: Conflict Invalid Journey Status

Update a Journey

Create a Journey

PATCH https://octeth.mydomain.com/api/v1/journey

Utilize this API call to modify the parameters of a journey.

Request Body

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	String	The ID number of the journey that needs to be deleted.
Name	String	Name of the journey
Trigger	Enum	Any of these trigger types: ListSubscription, ListUnsubscription, EmailOpen, EmailConversion, EmailLinkClick, Manual
Trigger_ListID	Integer	If the trigger is ListSubscription or ListUnsubscrpition, the value of this parameter must be 0 (any list) or a specific subscriber list ID.
Trigger_EmailkID	Integer	If the trigger is EmailOpen, EmailConversion, EmailLinkClick, the value of this parameter must be 0 (any email) or a specific email ID.

200: OK On Success

{
    "Journey": {
        "JourneyID": "6",
        "RelUserID": "1",
        "JourneyName": "Test",
        "Trigger": "EmailOpen:10",
        "TriggerParameters": {
            "EmailID": 10
        },
        "Status": "Disabled",
        "CreatedAt": "2023-08-11 18:13:17",
        "UpdatedAt": "2023-08-11 19:13:43"
    }
}

422: Unprocessable Entity Validation Error

400: Bad Request

404: Not Found

Update Journey Actions

Every time you would like to make a change on journey actions, you need to pass the entire action list to this API end-point.

WARNING: The entire action list must be provided. Missing actions in the provided action list will be deleted from the journey.

Update Journey Actions

PATCH https://octeth.mydomain.com/api/v1/journey.actions

Utilize this API end-point to set/update journey actions.

Request Body

Name	Type	Description
SessionID*	String	User session ID.
APIKey*	String	User API key.
JourneyID*	String	The ID number of the journey that needs to be deleted.
Actions*	Array	The list of action objects must be proivded. Please see below for action object structure.

200: OK On Success

{
    "Journey": 8,
    "Actions": [
        {
            "ActionID": 1,
            "RelParentActionID": 0,
            "ConditionType": "",
            "OrderNo": 1,
            "Action": "Wait",
            "ActionParameters": {
                "WaitUnit": "seconds",
                "WaitAmount": 20
            },
            "ActionParametersRaw": "{\"WaitUnit\":\"seconds\",\"WaitAmount\":20}",
            "Stats": {
                "ActiveSubscribers": "0"
            }
        },
        {
            "ActionID": 11,
            "RelParentActionID": 0,
            "ConditionType": "",
            "OrderNo": 2,
            "Action": "Wait",
            "ActionParameters": {
                "WaitUnit": "minutes",
                "WaitAmount": 10
            },
            "ActionParametersRaw": "{\"WaitUnit\":\"minutes\",\"WaitAmount\":10}",
            "Stats": {
                "ActiveSubscribers": "0"
            }
        }
    ]
}

422: Unprocessable Entity Validation Error

404: Not Found

Action Object

The action object varies for each action type. Below, you can find the list of action types and their object structures:

Wait

// Wait Action
{
    "ActionID":1, // If you provide an ActionID, it will update that specific action. Otherwise, set this parameter to "null" to create a new action.
    "Action":"Wait",
    "ParentActionCondition":"", // "", "Yes", "No". Set this parameter as empty unless you are setting an action for a yes/no condition.
    "WaitUnit":"seconds", // "seconds", "minutes", "hours", "days"
    "WaitAmount":20 // Integer
}