Suppress an address or domain

POST

suppressions

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

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

const { data, error } = await norbelys.suppressions.create({ emailOrDomain: "[email protected]" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "emailOrDomain": "[email protected]",
  "id": "sup_d4f8g2h6j0k4l8m2n6p0q4r8",
  "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
  "reason": "unsubscribed",
  "scope": "org",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "suppression"
}

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

emailOrDomain

string

required

The email address or bare domain to suppress.

Minimum string length: 1

Examples:

"[email protected]"

"acme.com"

programId

string

The campaign to scope to; required when scope is "program".

Example:

"prg_b2n4x8mq1w7e9rk3v5tz0yc6"

reason

string

Free-text note recording why the address is being suppressed.

Example:

"asked to be removed"

scope

enum<string>

Suppression scope: "org" (the default) suppresses everywhere; "program" suppresses within one campaign only.

Available options:

org,

program

Response

emailOrDomain

string

required

The suppressed email address or bare domain.

Examples:

"[email protected]"

"acme.com"

string

required

The suppression id.

Example:

"sup_d4f8g2h6j0k4l8m2n6p0q4r8"

programId

string | null

required

The campaign this suppression is scoped to, or null when scope is "org".

Example:

"prg_b2n4x8mq1w7e9rk3v5tz0yc6"

reason

string | null

required

Why the address was suppressed.

Example:

"unsubscribed"

scope

enum<string>

required

Suppression scope: "org" suppresses everywhere; "program" suppresses within one campaign only.

Available options:

org,

program

archivedAt

any

When the suppression was lifted (RFC 3339), or null while it is active.

createdAt

any

When it was added (RFC 3339).

object

any

default:suppression

Always "suppression".

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

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

const { data, error } = await norbelys.suppressions.create({ emailOrDomain: "[email protected]" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "emailOrDomain": "[email protected]",
  "id": "sup_d4f8g2h6j0k4l8m2n6p0q4r8",
  "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
  "reason": "unsubscribed",
  "scope": "org",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "suppression"
}

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

Suppress an address or domain

Authorizations

Headers

Body

Response