Spec - Journeys

Table Of Contents

• Get Journeys
• Pause Journey
• Resume Journey
• Get All Journeys

Get Journeys

This API fetches the journeys for an account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)

Output

Success or failure. List of journeys.

• JourneyID
• JourneyName

Example Request

<GetJourneysRequest></GetJourneysRequest>

Example Request (shared access users)

<GetJourneysRequest account_id="12345" group_id="1"></GetJourneysRequest>

Successful Response

<GetJourneysResponse>
    <Result>Success</Result>
    <Journeys>
        <Journey>
            <JourneyID>1</JourneyID>
            <JourneyName>Journey Users</JourneyName>
        </Journey>
        <Journey>
            <JourneyID>2</JourneyID>
            <JourneyName>Send Postcard</JourneyName>
        </Journey>
        <Journey>
            <JourneyID>3</JourneyID>
            <JourneyName>Requested Demo</JourneyName>
        </Journey>
    </Journeys>
</GetJourneysResponse>

Pause Journey

This API pauses the journey for one or more contacts.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• journey_id (required)
• request_id (optional)
• Contact_id (required)

Output

Success or failure. List of contacts with their JourneyID and ContactID.

Example Request (single contact)

<PauseJourneyRequest journey_id="1">
    <Contacts>
        <Contact_id>123</Contact_id>
    </Contacts>
</PauseJourneyRequest>

Example Request (multiple contacts)

<PauseJourneyRequest journey_id="1">
    <Contacts>
        <Contact_id request_id="a1b2c3">123</Contact_id>
        <Contact_id request_id="d4e5f6">623</Contact_id>
    </Contacts>
</PauseJourneyRequest>

Example Request (shared access users)

<PauseJourneyRequest account_id="12345" group_id="1" journey_id="1">
    <Contacts>
        <Contact_id>123</Contact_id>
        <Contact_id>623</Contact_id>
    </Contacts>
</PauseJourneyRequest>

Successful Response

<PauseJourneyResponse>
    <Contacts>
        <Contact request_id="a1b2c3">
            <Result>Success</Result>
            <JourneyID>1</JourneyID>
            <ContactID>123</ContactID>
        </Contact>
        <Contact request_id="d4e5f6">
            <Result>Success</Result>
            <JourneyID>1</JourneyID>
            <ContactID>623</ContactID>
        </Contact>
    </Contacts>
</PauseJourneyResponse>

Resume Journey

This API resumes the journey for one or more contacts.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• journey_id (required)
• request_id (optional)
• Contact_id (required)

Output

Success or failure. List of contacts with their JourneyID and ContactID.

Example Request (single contact)

<ResumeJourneyRequest journey_id="1">
    <Contacts>
        <Contact_id>123</Contact_id>
    </Contacts>
</ResumeJourneyRequest>

Example Request (multiple contacts)

<ResumeJourneyRequest journey_id="1">
    <Contacts>
        <Contact_id request_id="a1b2c3">123</Contact_id>
        <Contact_id request_id="d4e5f6">623</Contact_id>
    </Contacts>
</ResumeJourneyRequest>

Example Request (shared access users)

<ResumeJourneyRequest account_id="12345" group_id="1" journey_id="1">
    <Contacts>
        <Contact_id>123</Contact_id>
        <Contact_id>623</Contact_id>
    </Contacts>
</ResumeJourneyRequest>

Successful Response

<ResumeJourneyResponse>
    <Contacts>
        <Contact request_id="a1b2c3">
            <Result>Success</Result>
            <JourneyID>1</JourneyID>
            <ContactID>123</ContactID>
        </Contact>
        <Contact request_id="d4e5f6">
            <Result>Success</Result>
            <JourneyID>1</JourneyID>
            <ContactID>623</ContactID>
        </Contact>
    </Contacts>
</ResumeJourneyResponse>

Get All Journeys

This API fetches the journeys and journeys progress for a single contact.

Input

• contact_id (required)
• account_id (required for shared access users)
• group_id (required for shared access users)

Output

Success or failure. List of journeys and journey progress items.

Example Request

<GetAllJourneysRequest contact_id="1"></GetAllJourneysRequest>

Example Request (shared access users)

<GetAllJourneysRequest account_id="12345" group_id="1" contact_id="1"></GetAllJourneysRequest>

Successful Response

<GetAllJourneysResponse>
    <Result>Success</Result>
    <Journeys>
        <Journey>
            <JourneyID>12</JourneyID>
            <JourneyName>JourneyFlow Users</JourneyName>
            <JourneysProgress>
                <JourneyProgress>
                    <OperatorTitle>Start Journey</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170315152210</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Decision :: User160 (Account Status) contains Active</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170315152506</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Action :: Send Email :: Media File #7092 :: DRIP #1</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170315152610</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                    <Read>Y</Read>
                    <Click>N</Click>
                    <Unsub>N</Unsub>
                    <Bounce>N</Bounce>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Delay :: 48 Hours</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170315152905</DatetimeReachedCurrentOperator>
                    <Notes>Email sent successfully</Notes>
                    <Paused>N</Paused>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Decision :: Read Previous Email</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170317153014</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Action :: Send Email :: Media File #7098 :: DRIP #2</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170317153305</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                    <Read>Y</Read>
                    <Click>N</Click>
                    <Unsub>N</Unsub>
                    <Bounce>N</Bounce>
                </JourneyProgress>
                <JourneyProgress>
                    <OperatorTitle>Delay :: 48 Hours</OperatorTitle>
                    <DatetimeReachedCurrentOperator>20170317153410</DatetimeReachedCurrentOperator>
                    <Notes></Notes>
                    <Paused>N</Paused>
                </JourneyProgress>
            </JourneysProgress>
        </Journey>
    </Journeys>
</GetAllJourneysResponse>