API reference

Journeys.

List journeys and enrol a contact into one. Every request needs an API key in the Authorization header; the reference overview covers keys, errors and rate limits.

List journeys

GET/v1/journeysFull access key

List the journeys belonging to the calling team, newest first.

terminal

curl -X GET "https://app.usenotix.dev/api/v1/journeys" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.journeys.list();

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

journeys, _ = notix.journeys.list()

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$journeys = $notix->journeys->list();

Responses

200List journeys for the calling team, newest first

200 response fields
Field	Type	About
`id`required	`string`
`name`required	`string`
`status`required	`string`	One of `DRAFT`, `PENDING_REVIEW`, `ACTIVE`, `PAUSED`, `ARCHIVED`.
`triggerType`required	`string`	One of `CONTACT_ADDED`, `API`.
`contactBookId`required	`string`	Can be null.
`segmentId`required	`string`	Only contacts in this segment of the contact book are enrolled. Null enrols everyone. Can be null.
`exitWhenLeavesSegment`required	`boolean`	When true, a contact who stops matching the segment leaves the journey before its next email.
`steps`required	`object[]`
`stats`required	`object`
`stats.enrolled`required	`integer`
`stats.active`required	`integer`
`stats.completed`required	`integer`
`stats.exited`required	`integer`
`stats.failed`required	`integer`
`stats.sentByStep`required	`map of integer`	Emails sent per EMAIL step, keyed by step id
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

Get a journey

GET/v1/journeys/{id}Full access key

Retrieve one journey and its stats.

Path parameters
Field	Type	About
`id`required	`string`

terminal

curl -X GET "https://app.usenotix.dev/api/v1/journeys/<id>" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.journeys.get("jrn_123");

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

journey, _ = notix.journeys.get("jrn_123")

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$journey = $notix->journeys->get('jrn_123');

Responses

200The journey and its stats

200 response fields
Field	Type	About
`id`required	`string`
`name`required	`string`
`status`required	`string`	One of `DRAFT`, `PENDING_REVIEW`, `ACTIVE`, `PAUSED`, `ARCHIVED`.
`triggerType`required	`string`	One of `CONTACT_ADDED`, `API`.
`contactBookId`required	`string`	Can be null.
`segmentId`required	`string`	Only contacts in this segment of the contact book are enrolled. Null enrols everyone. Can be null.
`exitWhenLeavesSegment`required	`boolean`	When true, a contact who stops matching the segment leaves the journey before its next email.
`steps`required	`object[]`
`stats`required	`object`
`stats.enrolled`required	`integer`
`stats.active`required	`integer`
`stats.completed`required	`integer`
`stats.exited`required	`integer`
`stats.failed`required	`integer`
`stats.sentByStep`required	`map of integer`	Emails sent per EMAIL step, keyed by step id
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

404No journey with this id for the calling team

Enrol a contact

POST/v1/journeys/{id}/enrollSending or full access key

Enrol a contact into a journey, by contactId or by email within the journey's contact book. The contact's run starts at step 0. When the journey is limited to a segment, a contact who does not match answers 409 NOT_IN_SEGMENT; enrolling by email still adds the address to the contact book.

Path parameters
Field	Type	About
`id`required	`string`

Request body (JSON)
Field	Type	About
`contactId`	`string`	An existing contact's id. Provide this or email, not both.
`email`	`string`	An email address within the journey's contact book. Created there when it does not already exist. Provide this or contactId, not both.

terminal

curl -X POST "https://app.usenotix.dev/api/v1/journeys/<id>/enroll" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contactId": "cly1contact0000abcd",
  "email": "user@example.com"
}'

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.journeys.enroll("jrn_123", { email: "ada@example.com" });

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

run, _ = notix.journeys.enroll("jrn_123", {"email": "ada@example.com"})

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$run = $notix->journeys->enroll('jrn_123', ['email' => 'ada@example.com']);

Responses

201The contact is enrolled and its run created at step 0

201 response fields
Field	Type	About
`id`required	`string`
`journeyId`required	`string`
`contactId`required	`string`
`status`required	`string`	One of `ACTIVE`, `COMPLETED`, `EXITED`, `FAILED`.
`currentStepIndex`required	`integer`
`nextRunAt`required	`string (date-time)`
`exitReason`required	`string`	One of `UNSUBSCRIBED`, `JOURNEY_ARCHIVED`, `CONTACT_DELETED`, `SEND_FAILED`, `PROCESSING_ERROR`. Can be null.
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

400Neither or both of contactId/email were provided, the journey has no contact book for an email enrolment, the journey's contact book no longer exists, the contact book uses double opt-in and the contact has not confirmed, or the journey is DRAFT or ARCHIVED

404No journey with this id for the calling team

409The contact already has a run on this journey (NOT_UNIQUE), or the journey is limited to a segment the contact does not match (NOT_IN_SEGMENT)