Programs

Bulk-update programs

Apply ONE change to MANY campaigns at once, in a single call. Pass EITHER action — a lifecycle verb (archive, restore, pause, resume) — OR patch, the settings to set on all of them (pacing: sendIntervalMinutes / jitterMinSeconds / jitterMaxSeconds / newPerDay; sending window: windowFrom / windowTo / activeDays / timezone; tracking; auto-pause thresholds). Use this whenever the same change goes to several campaigns (e.g. ‘archive every campaign’, ‘pause them all’, ‘spread the sends out across the day’) INSTEAD of calling archive/pause/resume/update once per campaign — one call means one confirmation for the operator instead of one per campaign. It cannot rename campaigns, edit their emails, or change their mailbox pool. Returns how many changed plus any per-campaign errors.

POST

programs

bulk

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.programs.bulk({ ids: ["prg_b2n4x8mq1w7e9rk3v5tz0yc6"] });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "errors": [
    {
      "id": "<string>",
      "message": "<string>"
    }
  ],
  "object": "bulk_result",
  "programs": [
    {
      "activeDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "addUnsubscribe": true,
      "autoPauseOnCompanyReply": true,
      "bouncePauseThreshold": 2,
      "id": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "jitterMaxSeconds": 60,
      "jitterMinSeconds": 30,
      "kind": "cold_sequence",
      "name": "Q3 outbound — founders",
      "newPerDay": 25,
      "pausedMeta": {
        "rate": 6.7,
        "threshold": 2
      },
      "pausedReason": "bounce_rate",
      "plainTextMode": true,
      "senderTags": [
        "acme-pool"
      ],
      "sendIntervalMinutes": 5,
      "spamPauseThreshold": 0.3,
      "status": "active",
      "stopCondition": "reply",
      "timezone": "America/Chicago",
      "timezoneSource": "sender",
      "trackClicks": true,
      "trackingDomainId": "<string>",
      "trackOpens": true,
      "unsubscribeText": "<string>",
      "variantDistribution": "pattern",
      "windowFrom": "09:00",
      "windowTo": "17:00",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "program",
      "pausedAt": "<unknown>",
      "startDate": "2026-07-01T14:00:00.000Z",
      "updatedAt": "<unknown>"
    }
  ],
  "updated": 17
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Body

application/json

ids

string[]

required

The campaign ids to act on (1–200 per call).

Required array length: 1 - 200 elements

Example:

["prg_b2n4x8mq1w7e9rk3v5tz0yc6"]

action

enum<string>

Lifecycle verb to apply to every listed campaign. Omit when sending a patch.

Available options:

archive,

pause,

restore,

resume

Example:

"archive"

patch

object

Settings to set on EVERY listed campaign (pacing, window, tracking, auto-pause guards). Omit when sending an action.

Show child attributes

Response

errors

ProgramBulkError · object[]

required

Per-campaign failures — every other campaign still applied.

Show child attributes

object

any

required

Always "bulk_result". Identifies the result type.

programs

Program · object[]

required

The resulting campaigns.

Show child attributes

updated

integer

required

How many campaigns were changed.

Required range: x >= 0

Example:

17

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.programs.bulk({ ids: ["prg_b2n4x8mq1w7e9rk3v5tz0yc6"] });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "errors": [
    {
      "id": "<string>",
      "message": "<string>"
    }
  ],
  "object": "bulk_result",
  "programs": [
    {
      "activeDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "addUnsubscribe": true,
      "autoPauseOnCompanyReply": true,
      "bouncePauseThreshold": 2,
      "id": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "jitterMaxSeconds": 60,
      "jitterMinSeconds": 30,
      "kind": "cold_sequence",
      "name": "Q3 outbound — founders",
      "newPerDay": 25,
      "pausedMeta": {
        "rate": 6.7,
        "threshold": 2
      },
      "pausedReason": "bounce_rate",
      "plainTextMode": true,
      "senderTags": [
        "acme-pool"
      ],
      "sendIntervalMinutes": 5,
      "spamPauseThreshold": 0.3,
      "status": "active",
      "stopCondition": "reply",
      "timezone": "America/Chicago",
      "timezoneSource": "sender",
      "trackClicks": true,
      "trackingDomainId": "<string>",
      "trackOpens": true,
      "unsubscribeText": "<string>",
      "variantDistribution": "pattern",
      "windowFrom": "09:00",
      "windowTo": "17:00",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "program",
      "pausedAt": "<unknown>",
      "startDate": "2026-07-01T14:00:00.000Z",
      "updatedAt": "<unknown>"
    }
  ],
  "updated": 17
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Bulk-update programs

Authorizations

Headers

Body

Response