Create a group

POST

groups

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

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

const { data, error } = await norbelys.groups.create({ name: "VIP customers" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "color": "rose",
  "description": "Leads captured at the June webinar.",
  "id": "grp_tz4a98xat96iws9zmbrgj3a",
  "memberCount": 248,
  "name": "Event attendees — June",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "group",
  "updatedAt": "<unknown>"
}

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

name

string

required

The group's display name.

Required string length: 1 - 120

Example:

"VIP customers"

color

string

Optional accent color for the group's badge. Example: rose.

Maximum string length: 40

Example:

"rose"

description

string

Optional notes on what this group is for.

Maximum string length: 500

Example:

"Leads captured at the June webinar."

Response

color

string | null

required

Optional accent color for the group's badge. Example: rose.

Example:

"rose"

description

string | null

required

Optional notes on what this group is for.

Example:

"Leads captured at the June webinar."

string

required

The group id.

Example:

"grp_tz4a98xat96iws9zmbrgj3a"

memberCount

integer

required

Number of active people currently in the group.

Required range: x >= 0

Example:

248

name

string

required

The group's display name.

Example:

"Event attendees — June"

archivedAt

any

Timestamp (RFC 3339) when this was archived, or null if active.

createdAt

any

Creation timestamp (RFC 3339).

object

any

default:group

Always "group".

updatedAt

any

Last-update timestamp (RFC 3339).

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

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

const { data, error } = await norbelys.groups.create({ name: "VIP customers" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "color": "rose",
  "description": "Leads captured at the June webinar.",
  "id": "grp_tz4a98xat96iws9zmbrgj3a",
  "memberCount": 248,
  "name": "Event attendees — June",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "group",
  "updatedAt": "<unknown>"
}

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

Body

Response