API reference

Campaigns.

Create, schedule, pause and resume marketing campaigns. Every request needs an API key in the Authorization header; the reference overview covers keys, errors and rate limits.

Create a campaign

POST/v1/campaignsFull access key

Create a campaign. A team's first campaign is created but held for review before it can send, and answers 202. Pass segmentId to send only to the subscribed contacts of the book who match that segment when the send starts; the segment must belong to contactBookId.

Request body (JSON)
Field	Type	About
`name`required	`string`
`from`required	`string`
`subject`required	`string`	At most 998 characters.
`previewText`	`string`
`contactBookId`required	`string`
`segmentId`	`string`	Send only to this segment of the contact book. At most 64 characters.
`content`	`string`
`html`	`string`
`replyTo`	`string or string[]`
`cc`	`string or string[]`
`bcc`	`string or string[]`
`sendNow`	`boolean`
`scheduledAt`	`string`	Timestamp in ISO 8601 format or natural language (e.g., 'tomorrow 9am', 'next monday 10:30')
`batchSize`	`integer`	Minimum 1. Maximum 100000.

terminal

curl -X POST "https://app.usenotix.dev/api/v1/campaigns" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "from": "Acme <receipts@acme.com>",
  "subject": "Your receipt for order 4471",
  "contactBookId": "string"
}'

notix-js

import { Notix } from "notix-js";

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

const { data, error } = await notix.campaigns.create({
  name: "October newsletter",
  from: "Acme <news@acme.com>",
  subject: "What's new at {{company}}",
  contactBookId: "cb_123",
  html: '<p>Hi {{firstName,fallback=there}}</p><p><a href="{{notix_unsubscribe_url}}">Unsubscribe</a></p>',
});

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

campaign, _ = notix.campaigns.create({
    "name": "October newsletter",
    "from": "Acme <news@acme.com>",
    "subject": "What's new at {{company}}",
    "contactBookId": "cb_123",
    "html": '<p>Hi {{firstName,fallback=there}}</p><p><a href="{{notix_unsubscribe_url}}">Unsubscribe</a></p>',
})

usenotix/notix-php

use Notix\Notix;

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

$campaign = $notix->campaigns->create([
    'name' => 'October newsletter',
    'from' => 'Acme <news@acme.com>',
    'subject' => "What's new at {{company}}",
    'contactBookId' => 'cb_123',
    'html' => '<p>Hi {{firstName,fallback=there}}</p><p><a href="{{notix_unsubscribe_url}}">Unsubscribe</a></p>',
]);

Responses

200Create a campaign

200 response fields
Field	Type	About
`id`required	`string`
`name`required	`string`
`from`required	`string`
`subject`required	`string`	At most 998 characters.
`previewText`required	`string`	Can be null.
`contactBookId`required	`string`	Can be null.
`segmentId`required	`string`	Can be null.
`html`required	`string`	Can be null.
`content`required	`string`	Can be null.
`status`required	`string`
`scheduledAt`required	`string (date-time)`	Can be null.
`batchSize`required	`integer`
`batchWindowMinutes`required	`integer`
`total`required	`integer`
`sent`required	`integer`
`delivered`required	`integer`
`opened`required	`integer`
`clicked`required	`integer`
`unsubscribed`required	`integer`
`bounced`required	`integer`
`hardBounced`required	`integer`
`complained`required	`integer`
`replyTo`required	`string[]`
`cc`required	`string[]`
`bcc`required	`string[]`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

202The team's first campaign, created but held for review before it can send

202 response fields
Field	Type	About
`status`required	`string`	One of `pending_review`.
`message`required	`string`

List campaigns

GET/v1/campaignsFull access key

List the team's campaigns, paged and optionally filtered by status.

Query parameters
Field	Type	About
`page`	`integer`	1-based page number, at most 10000. Defaults to 1. Default `1`.
`status`	`string`	Filter campaigns by status One of `DRAFT`, `SCHEDULED`, `RUNNING`, `PAUSED`, `SENT`, `PENDING_REVIEW`.
`search`	`string`	Search campaigns by name or subject

terminal

curl -X GET "https://app.usenotix.dev/api/v1/campaigns" \
  -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.campaigns.getAll({ page: "1" });

usenotix/notix-php

use Notix\Notix;

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

$campaigns = $notix->campaigns->getAll(['page' => '1']);

Responses

200Get list of campaigns

200 response fields
Field	Type	About
`campaigns`required	`object[]`
`campaigns[].id`required	`string`
`campaigns[].name`required	`string`
`campaigns[].from`required	`string`
`campaigns[].subject`required	`string`
`campaigns[].createdAt`required	`string (date-time)`
`campaigns[].updatedAt`required	`string (date-time)`
`campaigns[].status`required	`string`
`campaigns[].scheduledAt`required	`string (date-time)`	Can be null.
`campaigns[].total`required	`integer`
`campaigns[].sent`required	`integer`
`campaigns[].delivered`required	`integer`
`campaigns[].unsubscribed`required	`integer`
`totalPage`required	`integer`

Get a campaign

GET/v1/campaigns/{campaignId}Full access key

Retrieve one campaign.

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

terminal

curl -X GET "https://app.usenotix.dev/api/v1/campaigns/<campaignId>" \
  -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.campaigns.get("cmp_123");

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

campaign, _ = notix.campaigns.get("cmp_123")

usenotix/notix-php

use Notix\Notix;

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

$campaign = $notix->campaigns->get('cmp_123');

Responses

200Get campaign details

200 response fields
Field	Type	About
`id`required	`string`
`name`required	`string`
`from`required	`string`
`subject`required	`string`	At most 998 characters.
`previewText`required	`string`	Can be null.
`contactBookId`required	`string`	Can be null.
`segmentId`required	`string`	Can be null.
`html`required	`string`	Can be null.
`content`required	`string`	Can be null.
`status`required	`string`
`scheduledAt`required	`string (date-time)`	Can be null.
`batchSize`required	`integer`
`batchWindowMinutes`required	`integer`
`total`required	`integer`
`sent`required	`integer`
`delivered`required	`integer`
`opened`required	`integer`
`clicked`required	`integer`
`unsubscribed`required	`integer`
`bounced`required	`integer`
`hardBounced`required	`integer`
`complained`required	`integer`
`replyTo`required	`string[]`
`cc`required	`string[]`
`bcc`required	`string[]`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

Delete a campaign

DELETE/v1/campaigns/{campaignId}Full access key

Delete a campaign.

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

terminal

curl -X DELETE "https://app.usenotix.dev/api/v1/campaigns/<campaignId>" \
  -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.campaigns.delete("cmp_123");

usenotix/notix-php

use Notix\Notix;

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

$result = $notix->campaigns->delete('cmp_123');

Responses

200Delete campaign

200 response fields
Field	Type	About
`id`required	`string`
`name`required	`string`
`from`required	`string`
`subject`required	`string`	At most 998 characters.
`previewText`required	`string`	Can be null.
`contactBookId`required	`string`	Can be null.
`segmentId`required	`string`	Can be null.
`html`required	`string`	Can be null.
`content`required	`string`	Can be null.
`status`required	`string`
`scheduledAt`required	`string (date-time)`	Can be null.
`batchSize`required	`integer`
`batchWindowMinutes`required	`integer`
`total`required	`integer`
`sent`required	`integer`
`delivered`required	`integer`
`opened`required	`integer`
`clicked`required	`integer`
`unsubscribed`required	`integer`
`bounced`required	`integer`
`hardBounced`required	`integer`
`complained`required	`integer`
`replyTo`required	`string[]`
`cc`required	`string[]`
`bcc`required	`string[]`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`

Schedule a campaign

POST/v1/campaigns/{campaignId}/scheduleFull access key

Schedule a campaign to send at a time, or now. A campaign still held for review answers 202.

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

Request body (JSON)
Field	Type	About
`scheduledAt`	`string`	Timestamp in ISO 8601 format or natural language (e.g., 'tomorrow 9am', 'next monday 10:30')
`batchSize`	`integer`	Minimum 1. Maximum 100000.

terminal

curl -X POST "https://app.usenotix.dev/api/v1/campaigns/<campaignId>/schedule" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "scheduledAt": "string",
  "batchSize": 1
}'

notix-js

import { Notix } from "notix-js";

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

const { data, error } = await notix.campaigns.schedule("cmp_123", {
  scheduledAt: "2026-10-01T09:00:00Z",
  batchSize: 1000,
});

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

result, _ = notix.campaigns.schedule("cmp_123", {"scheduledAt": "2026-10-01T09:00:00Z", "batchSize": 1000})

usenotix/notix-php

use Notix\Notix;

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

$result = $notix->campaigns->schedule('cmp_123', ['scheduledAt' => '2026-10-01T09:00:00Z', 'batchSize' => 1000]);

Responses

200Schedule a campaign

200 response fields
Field	Type	About
`success`required	`boolean`

202The team's first campaign, held for review before it can send

202 response fields
Field	Type	About
`status`required	`string`	One of `pending_review`.
`message`required	`string`

Pause a campaign

POST/v1/campaigns/{campaignId}/pauseFull access key

Stop a sending campaign. Emails already sent stay sent.

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

terminal

curl -X POST "https://app.usenotix.dev/api/v1/campaigns/<campaignId>/pause" \
  -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.campaigns.pause("cmp_123");

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

result, _ = notix.campaigns.pause("cmp_123")

usenotix/notix-php

use Notix\Notix;

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

$result = $notix->campaigns->pause('cmp_123');

Responses

200Pause a campaign

200 response fields
Field	Type	About
`success`required	`boolean`

Resume a campaign

POST/v1/campaigns/{campaignId}/resumeFull access key

Continue a paused campaign. A campaign still held for review answers 202.

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

terminal

curl -X POST "https://app.usenotix.dev/api/v1/campaigns/<campaignId>/resume" \
  -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.campaigns.resume("cmp_123");

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

result, _ = notix.campaigns.resume("cmp_123")

usenotix/notix-php

use Notix\Notix;

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

$result = $notix->campaigns->resume('cmp_123');

Responses

200Resume a campaign

200 response fields
Field	Type	About
`success`required	`boolean`

202The team's held campaign, still waiting for review before it can resume

202 response fields
Field	Type	About
`status`required	`string`	One of `pending_review`.
`message`required	`string`