Senders

Bulk-update senders

Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. ‘set every sender to 50/day’, ‘pause all senders’) INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so ‘make each sender send at a different hour’ means splitting senders across campaigns with different windows, not a sender edit.

POST

senders

bulk

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

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

const { data, error } = await norbelys.senders.bulk({ ids: ["snd_pfh0haxfpzowht3oi213cqos"], patch: { bccCrmEmail: "[email protected]", clientLabel: "Acme Corp", dailyLimit: 50, minGapMinutes: 5 } });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "errors": [
    {
      "id": "<string>",
      "message": "<string>"
    }
  ],
  "object": "bulk_result",
  "senders": [
    {
      "bccCrmEmail": "[email protected]",
      "clientLabel": "Acme Corp",
      "dailyLimit": 50,
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapSecurity": "ssl",
      "minGapMinutes": 5,
      "replyTo": "[email protected]",
      "reputation": "good",
      "sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
      "signatureHtml": "<string>",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 465,
      "smtpSecurity": "ssl",
      "state": "healthy",
      "tags": [
        "acme-pool",
        "us"
      ],
      "transportMode": "smtp",
      "transportProvider": "google",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "healthUpdatedAt": "<unknown>",
      "object": "sender",
      "updatedAt": "<unknown>"
    }
  ],
  "updated": 28
}

{
  "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 mailbox ids to update (1–200 per call).

Required array length: 1 - 200 elements

Example:

["snd_pfh0haxfpzowht3oi213cqos"]

patch

BulkUpdateSenderPatch · object

required

The fields to set on EVERY listed mailbox (pacing/lifecycle/warmup/labels only — no credentials or transport, so no test send fires).

Show child attributes

Response

errors

SenderBulkError · object[]

required

Per-mailbox failures — every other mailbox still updated.

Show child attributes

object

any

required

Always "bulk_result". Identifies the result type.

senders

Sender · object[]

required

The updated mailboxes.

Show child attributes

updated

integer

required

How many mailboxes were updated.

Required range: x >= 0

Example:

28

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

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

const { data, error } = await norbelys.senders.bulk({ ids: ["snd_pfh0haxfpzowht3oi213cqos"], patch: { bccCrmEmail: "[email protected]", clientLabel: "Acme Corp", dailyLimit: 50, minGapMinutes: 5 } });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "errors": [
    {
      "id": "<string>",
      "message": "<string>"
    }
  ],
  "object": "bulk_result",
  "senders": [
    {
      "bccCrmEmail": "[email protected]",
      "clientLabel": "Acme Corp",
      "dailyLimit": 50,
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapSecurity": "ssl",
      "minGapMinutes": 5,
      "replyTo": "[email protected]",
      "reputation": "good",
      "sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
      "signatureHtml": "<string>",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 465,
      "smtpSecurity": "ssl",
      "state": "healthy",
      "tags": [
        "acme-pool",
        "us"
      ],
      "transportMode": "smtp",
      "transportProvider": "google",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "healthUpdatedAt": "<unknown>",
      "object": "sender",
      "updatedAt": "<unknown>"
    }
  ],
  "updated": 28
}

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

Authorizations

Headers

Body

Response