Attach a sender to a program

POST

programs

{id}

senders

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

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

const { data, error } = await norbelys.programs.senders.add("prg_y3rgwmhkbgxx", { senderId: "…" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "fromEmail": "[email protected]",
  "fromName": "Ada from Acme",
  "id": "snd_pfh0haxfpzowht3oi213cqos",
  "dailyLimit": 50,
  "minGapMinutes": 6,
  "nextSendAt": "<unknown>",
  "poolQueued": 9814,
  "queued": 12,
  "reputation": "good",
  "state": "healthy",
  "via": "tag"
}

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

Body

application/json

senderId

string

required

The sender to attach.

Response

fromEmail

string<email>

required

The sender's from address.

Example:

"[email protected]"

fromName

string

required

The sender's display name.

Example:

"Ada from Acme"

string

required

The sender id.

Example:

"snd_pfh0haxfpzowht3oi213cqos"

dailyLimit

integer

The mailbox's own daily send ceiling. Carried here so a caller can render the fleet without a second lookup.

Required range: x >= 0

Example:

50

minGapMinutes

integer

Minimum minutes between two sends from this mailbox.

Required range: x >= 0

Example:

6

nextSendAt

any

When this mailbox's next scheduled send in this program is due (RFC 3339), or null. A past instant means it is due now and goes out on the mailbox's next turn. Accounts for BOTH the threads this mailbox owns and the shared pool it can pull from — a mailbox with pool work due is 'now', never the date of its own far-off follow-up.

poolQueued

integer

Leads due in this program's SHARED pool — not owned by any mailbox, so every attached mailbox can pull from them. The same number repeats on every row of the list: it is the campaign's backlog, not this mailbox's.

Required range: x >= 0

Example:

9814

queued

integer

Active leads whose thread this mailbox owns and that still have a send scheduled in this program. Only present in list responses.

Required range: x >= 0

Example:

12

reputation

string | null

Latest reputation verdict for the mailbox, when known.

Example:

"good"

state

string

The mailbox's operational state (healthy / throttled / paused).

Example:

"healthy"

via

enum<string>

How the mailbox is attached: manual (explicit attach) or tag (matched by the campaign's senderTags selector — detach it by changing the tags, not by remove).

Available options:

manual,

tag

Example:

"tag"

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

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

const { data, error } = await norbelys.programs.senders.add("prg_y3rgwmhkbgxx", { senderId: "…" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "fromEmail": "[email protected]",
  "fromName": "Ada from Acme",
  "id": "snd_pfh0haxfpzowht3oi213cqos",
  "dailyLimit": 50,
  "minGapMinutes": 6,
  "nextSendAt": "<unknown>",
  "poolQueued": 9814,
  "queued": 12,
  "reputation": "good",
  "state": "healthy",
  "via": "tag"
}

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

Attach a sender to a program

Authorizations

Headers

Path Parameters

Body

Response