A campaign sends one approved WhatsApp template to an audience of contact lists, segments and individual contacts. You create it as a DRAFT, then either schedule it for later or run it now, and follow it through the delivery endpoints.

The lifecycle: DRAFT → SCHEDULED or IN_PROGRESS → FINISHED. A running or scheduled campaign can be cancelled. Only a draft can be edited or deleted — updating anything else answers 409. FAILED and STOPPED exist in the status list, but none of these endpoints sets them.

Endpoints

GET/campaignsList campaignsGET/campaigns/{campaignId}Retrieve a campaignPOST/campaignsCreate a campaignPUT/campaigns/{campaignId}Update a campaignPOST/campaigns/{campaignId}/scheduleSchedule a campaignPOST/campaigns/{campaignId}/runsSend a campaign nowPOST/campaigns/{campaignId}/cancelCancel a campaignGET/campaigns/{campaignId}/delivery/summaryRetrieve delivery countsGET/campaigns/{campaignId}/deliveryList deliveriesGET/campaigns/{campaignId}/delivery/{deliveryId}Retrieve a deliveryPOST/campaigns/{campaignId}/target-previewPreview the audienceDELETE/campaigns/{campaignId}Delete a campaign

The campaign object

The response carries a message summary (template name and language), not the full payloadJson: send that on create and update.

Attributes

• idinteger
  Unique identifier of the campaign.
• orgIdinteger
  Your organisation.
• namestring
  Campaign name.
• campaignTypestring
  The kind of campaign, a free string. Defaults to BROADCAST: one template message to an audience.
• channelConfigIdinteger
  The WhatsApp channel line the campaign sends through.
• fallbackChannelConfigIdintegernullable
  The channel line used for the fallback message, if one is set.
• statusstring
  Where the campaign is in its life. Only a DRAFT can be edited.
  One of: DRAFTSCHEDULEDIN_PROGRESSFINISHEDSTOPPEDCANCELLEDFAILED
• targetingobject
  Who receives it. You can combine lists, segments and individual contacts.
• messageobjectnullable
  A summary of the message, not the full payloadJson. null until a message is saved.
• createdByobjectnullable
  Who created the campaign.
• wizardStatejsonnullable
  Whatever the dashboard’s campaign wizard saved so it can resume a draft. Natiq stores it as given.
• scheduledAtstringnullable
  When a scheduled campaign sends (ISO 8601).
• startedAtstringnullable
  When sending began.
• finishedAtstringnullable
  When sending ended.
• createdAtstring
  When the campaign was created.
• updatedAtstring
  When it was last changed.

The campaign object

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "DRAFT",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": null,
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

List campaigns

Returns a page of campaigns, newest first.

Requires campaigns.campaign:read Offset paginated

Query parameters

• pageinteger
  Zero-based page number. Default 0.
• sizeinteger
  Page size. Default 20; keep it at 100 or below.
• namestring
  Only campaigns whose name contains this text, case-insensitive.
• statusstring
  Only campaigns in this status.
  One of: DRAFTSCHEDULEDIN_PROGRESSFINISHEDSTOPPEDCANCELLEDFAILED
• channelConfigIdinteger
  Only campaigns on this channel line.
• createdFromstring
  Only campaigns created at or after this ISO 8601 instant.
• createdTostring
  Only campaigns created at or before this ISO 8601 instant.

Returns

200A page of results.

Errors

• 400INVALID_REQUESTThe `status` is not a known value, or `createdFrom` is after `createdTo`.

cURL

curl -X GET "https://api.cx.na6iq.com/api/v1/campaigns?page=0&size=25" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns?page=0&size=25', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.get(
    "https://api.cx.na6iq.com/api/v1/campaigns?page=0&size=25",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "data": [
    {
      "id": 301,
      "orgId": 12,
      "name": "Order shipped — November",
      "campaignType": "BROADCAST",
      "channelConfigId": 22,
      "status": "DRAFT",
      "targeting": {
        "listIds": [
          7
        ],
        "segmentIds": [
          12
        ],
        "contactIds": []
      },
      "fallbackChannelConfigId": null,
      "message": {
        "channelType": "WHATSAPP",
        "templateName": "order_shipped",
        "language": "ar",
        "headerMediaUrl": null
      },
      "createdBy": {
        "userId": 41,
        "username": "layla",
        "email": "layla@example.com"
      },
      "wizardState": null,
      "scheduledAt": null,
      "startedAt": null,
      "finishedAt": null,
      "createdAt": "2026-11-06T12:00:00Z",
      "updatedAt": "2026-11-06T12:00:00Z"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1
}

Retrieve a campaign

Returns one campaign.

Requires campaigns.campaign:read

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Returns

200The campaign object.

Errors

• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X GET "https://api.cx.na6iq.com/api/v1/campaigns/42" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.get(
    "https://api.cx.na6iq.com/api/v1/campaigns/42",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "DRAFT",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": null,
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

Create a campaign

Creates a campaign in DRAFT. Nothing is sent until you schedule it or run it. No field is required on save: a draft saves incomplete, and scheduling checks it.

Requires campaigns.campaign:write

Request body

• namestring
  Campaign name.
• channelConfigIdinteger
  The WhatsApp channel line to send through.
• campaignTypestring
  Defaults to BROADCAST.
• targetingobject
  The audience. Every array is optional.
• messageobject
  What to send.
• fallbackChannelConfigIdinteger
  A second channel line to use for the fallback message.
• fallbackMessageobject
  The fallback message to send on that line.
• wizardStatejson
  Free-form state for the dashboard’s campaign wizard. Natiq stores it as given.

Returns

201The campaign object.

Errors

• 404CHANNEL_CONFIG_NOT_FOUNDThe `channelConfigId` (or fallback line) is not a channel in your organisation.
• 404CONTACT_LIST_NOT_FOUNDA targeting list, segment or contact does not exist. The code is `CONTACT_LIST_NOT_FOUND`, `SEGMENT_NOT_FOUND` or `CONTACT_NOT_FOUND`, depending on which one is missing.
• 409CAMPAIGN_CHANNEL_MISMATCHThe message’s channel type does not match the channel line.
• 400INVALID_REQUESTThe body is not valid JSON.

cURL

curl -X POST "https://api.cx.na6iq.com/api/v1/campaigns" \
  -H "Authorization: Bearer $NATIQ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Order shipped — November",
  "channelConfigId": 22,
  "campaignType": "BROADCAST",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "message": {
    "channelType": "WHATSAPP",
    "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
  }
}'

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Order shipped — November",
    "channelConfigId": 22,
    "campaignType": "BROADCAST",
    "targeting": {
      "listIds": [
        7
      ],
      "segmentIds": [
        12
      ],
      "contactIds": []
    },
    "message": {
      "channelType": "WHATSAPP",
      "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
    }
  }),
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.post(
    "https://api.cx.na6iq.com/api/v1/campaigns",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
    json={
      "name": "Order shipped — November",
      "channelConfigId": 22,
      "campaignType": "BROADCAST",
      "targeting": {
        "listIds": [
          7
        ],
        "segmentIds": [
          12
        ],
        "contactIds": []
      },
      "message": {
        "channelType": "WHATSAPP",
        "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
      }
    },
)
res.raise_for_status()
data = res.json()

Response201

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "DRAFT",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": null,
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

Update a campaign

Updates a draft. name and targeting are replaced, so send them every time; if message is omitted the stored message is kept. Allowed only while the status is DRAFT. No field is required: a draft saves incomplete, and scheduling checks it.

Requires campaigns.campaign:write

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Request body

• namestring
  Campaign name.
• channelConfigIdinteger
  The WhatsApp channel line to send through.
• campaignTypestring
  Defaults to BROADCAST.
• targetingobject
  The audience. Every array is optional.
• messageobject
  What to send.
• fallbackChannelConfigIdinteger
  A second channel line to use for the fallback message.
• fallbackMessageobject
  The fallback message to send on that line.
• wizardStatejson
  Free-form state for the dashboard’s campaign wizard. Natiq stores it as given.

Returns

200The campaign object.

Errors

• 409CAMPAIGN_NOT_EDITABLEOnly drafts can be updated, and this campaign has left `DRAFT`.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.
• 404CHANNEL_CONFIG_NOT_FOUNDThe `channelConfigId` (or fallback line) is not a channel in your organisation.
• 404CONTACT_LIST_NOT_FOUNDA targeting list, segment or contact does not exist. The code is `CONTACT_LIST_NOT_FOUND`, `SEGMENT_NOT_FOUND` or `CONTACT_NOT_FOUND`, depending on which one is missing.
• 409CAMPAIGN_CHANNEL_MISMATCHThe message’s channel type does not match the channel line.
• 400INVALID_REQUESTThe body is not valid JSON.

cURL

curl -X PUT "https://api.cx.na6iq.com/api/v1/campaigns/42" \
  -H "Authorization: Bearer $NATIQ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Order shipped — November (final)",
  "channelConfigId": 22,
  "campaignType": "BROADCAST",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "message": {
    "channelType": "WHATSAPP",
    "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
  }
}'

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Order shipped — November (final)",
    "channelConfigId": 22,
    "campaignType": "BROADCAST",
    "targeting": {
      "listIds": [
        7
      ],
      "segmentIds": [
        12
      ],
      "contactIds": []
    },
    "message": {
      "channelType": "WHATSAPP",
      "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
    }
  }),
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.put(
    "https://api.cx.na6iq.com/api/v1/campaigns/42",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
    json={
      "name": "Order shipped — November (final)",
      "channelConfigId": 22,
      "campaignType": "BROADCAST",
      "targeting": {
        "listIds": [
          7
        ],
        "segmentIds": [
          12
        ],
        "contactIds": []
      },
      "message": {
        "channelType": "WHATSAPP",
        "payloadJson": "{\"templateName\":\"order_shipped\",\"language\":\"ar\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"ليلى\"},{\"type\":\"text\",\"text\":\"A-1001\"}]}]}"
      }
    },
)
res.raise_for_status()
data = res.json()

Response200

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November (final)",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "DRAFT",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": null,
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

Schedule a campaign

Sets the time the campaign sends and moves it to SCHEDULED. Scheduling is its own permission, separate from editing.

Requires campaigns.campaign:schedule

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Request body

• scheduledAtstringrequired
  When to send, as an ISO 8601 instant.

Returns

200The campaign object.

Errors

• 409CAMPAIGN_INVALID_STATUSOnly a `DRAFT` can be scheduled.
• 400CAMPAIGN_INCOMPLETEThe draft is missing something it needs. `error.details` lists what: the name, channel, audience or message.
• 400VALIDATION_FAILED`scheduledAt` is missing.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X POST "https://api.cx.na6iq.com/api/v1/campaigns/42/schedule" \
  -H "Authorization: Bearer $NATIQ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "scheduledAt": "2026-11-10T07:00:00Z"
}'

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/schedule', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "scheduledAt": "2026-11-10T07:00:00Z"
  }),
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.post(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/schedule",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
    json={
      "scheduledAt": "2026-11-10T07:00:00Z"
    },
)
res.raise_for_status()
data = res.json()

Response200

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "SCHEDULED",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": "2026-11-10T07:00:00Z",
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

Send a campaign now

Dispatches a run immediately. Allowed from DRAFT, SCHEDULED or IN_PROGRESS. It answers 202 Accepted: the run is prepared before the response returns (READY), materializedCount reports how many deliveries were created, and sending continues in the background. Follow progress with Retrieve delivery counts.

Requires campaigns.campaign:schedule

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Returns

202The campaign object.

Errors

• 409CAMPAIGN_INVALID_STATUSThe campaign is not in `DRAFT`, `SCHEDULED` or `IN_PROGRESS`.
• 409CAMPAIGN_MESSAGE_REQUIREDThe campaign has no message yet.
• 409CAMPAIGN_CHANNEL_REQUIREDThe campaign has no channel line yet.
• 409CAMPAIGN_CHANNEL_MISMATCHThe message’s channel type does not match the channel line.
• 409CAMPAIGN_TARGET_REQUIREDThe campaign has no audience yet.
• 404CHANNEL_CONFIG_NOT_FOUNDThe campaign’s channel line no longer exists in your organisation.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X POST "https://api.cx.na6iq.com/api/v1/campaigns/42/runs" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/runs', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.post(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/runs",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response202

{
  "id": 884,
  "campaignId": 301,
  "status": "READY",
  "materializedCount": 470
}

Cancel a campaign

Stops a live campaign — one that is scheduled or sending — and returns it. Messages already sent are not recalled.

Requires campaigns.campaign:write

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Returns

200The campaign object.

Errors

• 409CAMPAIGN_INVALID_STATUSOnly a `SCHEDULED` or `IN_PROGRESS` campaign can be cancelled.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X POST "https://api.cx.na6iq.com/api/v1/campaigns/42/cancel" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/cancel', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.post(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/cancel",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "id": 301,
  "orgId": 12,
  "name": "Order shipped — November",
  "campaignType": "BROADCAST",
  "channelConfigId": 22,
  "status": "CANCELLED",
  "targeting": {
    "listIds": [
      7
    ],
    "segmentIds": [
      12
    ],
    "contactIds": []
  },
  "fallbackChannelConfigId": null,
  "message": {
    "channelType": "WHATSAPP",
    "templateName": "order_shipped",
    "language": "ar",
    "headerMediaUrl": null
  },
  "createdBy": {
    "userId": 41,
    "username": "layla",
    "email": "layla@example.com"
  },
  "wizardState": null,
  "scheduledAt": null,
  "startedAt": null,
  "finishedAt": null,
  "createdAt": "2026-11-06T12:00:00Z",
  "updatedAt": "2026-11-06T12:00:00Z"
}

Retrieve delivery counts

Returns how many messages are in each delivery state.

Requires campaigns.reports:read

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Returns

200The campaign object.

Errors

• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X GET "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/summary" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/summary', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.get(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/summary",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "total": 470,
  "pending": 0,
  "sent": 12,
  "delivered": 301,
  "read": 142,
  "failed": 15,
  "stopped": 0,
  "cancelled": 0,
  "updatedAt": "2026-11-10T07:12:30Z"
}

List deliveries

Returns one row per contact the campaign messaged, oldest first, as a plain array. Keyset paginated: pass the largest id on the page as afterId to get the next rows. Filter with status to find the failures. contactDisplayName and contactPhone can be null.

Requires campaigns.reports:read Keyset paginated

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Query parameters

• afterIdinteger
  Return rows after this ID. 0 or omitted starts from the oldest.
• sizeinteger
  Rows per page, clamped to 1–100. Default 50.
• statusstring
  Only rows in this state. An exact match, so use uppercase.
  One of: PENDINGSENTDELIVEREDREADFAILEDSTOPPEDCANCELLED

Returns

200The campaign object.

Errors

• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X GET "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery?size=25" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/delivery?size=25', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.get(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery?size=25",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

[
  {
    "id": 9120,
    "campaignId": 301,
    "dispatchRunId": 884,
    "contactId": 1842,
    "contactDisplayName": "Layla Haddad",
    "contactPhone": "+966500000001",
    "status": "DELIVERED",
    "sentAt": "2026-11-10T07:00:04Z",
    "deliveredAt": "2026-11-10T07:00:06Z",
    "readAt": null,
    "failedAt": null,
    "errorMessage": null,
    "createdAt": "2026-11-10T07:00:01Z"
  }
]

Retrieve a delivery

Returns one delivery row.

Requires campaigns.reports:read

Path parameters

• campaignIdintegerrequired
  The campaign’s id.
• deliveryIdintegerrequired
  The delivery row’s id.

Returns

200The campaign object.

Errors

• 404DELIVERY_NOT_FOUNDNo delivery with this ID on the campaign.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X GET "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/42" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/42', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.get(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/delivery/42",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "id": 9120,
  "campaignId": 301,
  "dispatchRunId": 884,
  "contactId": 1842,
  "contactDisplayName": "Layla Haddad",
  "contactPhone": "+966500000001",
  "status": "DELIVERED",
  "sentAt": "2026-11-10T07:00:04Z",
  "deliveredAt": "2026-11-10T07:00:06Z",
  "readAt": null,
  "failedAt": null,
  "errorMessage": null,
  "createdAt": "2026-11-10T07:00:01Z"
}

Preview the audience

Returns a page of the contacts the campaign would reach with its current targeting. Nothing is sent.

Requires campaigns.campaign:read Offset paginated

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Query parameters

• pageinteger
  Zero-based page number. Default 0.
• sizeinteger
  Page size.

Returns

200A page of results.

Errors

• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X POST "https://api.cx.na6iq.com/api/v1/campaigns/42/target-preview?page=0&size=25" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42/target-preview?page=0&size=25', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)
const data = await res.json()

Python

import os, requests

res = requests.post(
    "https://api.cx.na6iq.com/api/v1/campaigns/42/target-preview?page=0&size=25",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()
data = res.json()

Response200

{
  "data": [
    {
      "id": 1842,
      "displayName": "Layla Haddad",
      "email": "layla@example.com",
      "phone": "+966500000001",
      "status": "customer"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 470,
  "totalPages": 24
}

Delete a campaign

Deletes a campaign. Only a DRAFT can be deleted.

Requires campaigns.campaign:write

Path parameters

• campaignIdintegerrequired
  The campaign’s id.

Returns

204The campaign is deleted.

Errors

• 409CAMPAIGN_NOT_DELETABLEThe campaign has left `DRAFT`.
• 404CAMPAIGN_NOT_FOUNDNo campaign with this ID in your organisation.

cURL

curl -X DELETE "https://api.cx.na6iq.com/api/v1/campaigns/42" \
  -H "Authorization: Bearer $NATIQ_TOKEN"

JavaScript

const res = await fetch('https://api.cx.na6iq.com/api/v1/campaigns/42', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.NATIQ_TOKEN}`,
  },
})
if (!res.ok) throw new Error((await res.json().catch(() => ({}))).error?.message ?? `HTTP ${res.status}`)

Python

import os, requests

res = requests.delete(
    "https://api.cx.na6iq.com/api/v1/campaigns/42",
    headers={"Authorization": f"Bearer {os.environ['NATIQ_TOKEN']}"},
)
res.raise_for_status()