All API categories

    Journeys API

    5 endpoints

    Customer journey automation.

    GET
    Auth Required

    journeys.list

    journeys.list

    Endpoint

    /admin/collection/{collectionId}/journeys

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "JourneyList"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    journeys.create

    journeys.create

    Endpoint

    /admin/collection/{collectionId}/journeys

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CreateJourneyBody
    Required

    See CreateJourneyBody schema

    Responses

    200
    Success
    {
  "schema": "JourneyRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    journeys.get

    journeys.get

    Endpoint

    /admin/collection/{collectionId}/journeys/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "JourneyRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PATCH
    Auth Required

    journeys.update

    journeys.update

    Endpoint

    /admin/collection/{collectionId}/journeys/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    UpdateJourneyBody
    Required

    See UpdateJourneyBody schema

    Responses

    200
    Success
    {
  "schema": "JourneyRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    DELETE
    Auth Required

    journeys.remove

    journeys.remove

    Endpoint

    /admin/collection/{collectionId}/journeys/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found