Launch a program

POST

programs

{id}

launch

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

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

const { data, error } = await norbelys.programs.launch("prg_y3rgwmhkbgxx", { startDate: 1767283200000 });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
  "status": "active",
  "warnings": [
    "Cold outreach is commercial under CAN-SPAM and needs an easy opt-out. Enabling one-click unsubscribe is strongly recommended."
  ]
}

{
  "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

Path Parameters

string

required

The program id to launch.

Body

application/json

startDate

integer | null

Scheduled first-send instant (epoch ms). Omit/null = start now. Locked after launch.

Required range: x >= 0

Example:

1767283200000

Response

programId

string

required

The program id.

Example:

"prg_b2n4x8mq1w7e9rk3v5tz0yc6"

status

enum<string>

required

Always "active" on success.

Available options:

draft,

active,

paused,

done

Example:

"active"

warnings

string[]

required

Non-fatal compliance advisories (e.g. cold campaign without one-click unsubscribe). The launch still succeeded.

Example:

[
  "Cold outreach is commercial under CAN-SPAM and needs an easy opt-out. Enabling one-click unsubscribe is strongly recommended."
]

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

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

const { data, error } = await norbelys.programs.launch("prg_y3rgwmhkbgxx", { startDate: 1767283200000 });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
  "status": "active",
  "warnings": [
    "Cold outreach is commercial under CAN-SPAM and needs an easy opt-out. Enabling one-click unsubscribe is strongly recommended."
  ]
}

{
  "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

Authorizations

Headers

Path Parameters

Body

Response