Organization

Update the organization

Update the workspace’s editable profile and settings: company profile, onboarding state, the opt-in deliverability watchdog, deliverability email preference, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org’s registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.

PATCH

organization

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

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

const { data, error } = await norbelys.organization.update({ alerts: { deliverability: true }, bouncePolicy: { stopOnSoftFailure: true, suppressOnSoftStop: true }, complete: true, profile: { industry: "B2B SaaS", teamSize: "2-10", website: "https://acme.com" } });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alerts": {
    "deliverability": true
  },
  "bouncePolicy": {
    "stopOnSoftFailure": true,
    "suppressOnSoftStop": true
  },
  "name": "Acme",
  "onboarding": {
    "completed": true,
    "completedAt": 1765432100000
  },
  "orgId": "org_2y8KqM4wXv1Z",
  "profile": {
    "industry": "B2B SaaS",
    "teamSize": "2-10",
    "website": "https://acme.com"
  },
  "tenantReady": true,
  "watchdog": {
    "enabled": true
  }
}

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

Body

application/json

alerts

OrganizationAlertsParams · object

Notification preferences to update.

Show child attributes

bouncePolicy

OrganizationBouncePolicyParams · object

Bounce-handling policy to update.

Show child attributes

complete

boolean

Mark onboarding complete (only applied once the organization is provisioned).

profile

OrganizationProfileParams · object

Company profile fields to update.

Show child attributes

watchdog

OrganizationWatchdogParams · object

Deliverability watchdog settings to update.

Show child attributes

Response

The organization's current state: profile, onboarding, notification/watchdog settings, and whether provisioning is complete.

alerts

OrganizationAlerts · object

required

Notification preferences.

Show child attributes

bouncePolicy

OrganizationBouncePolicy · object

required

Bounce-handling policy for soft delivery failures.

Show child attributes

name

string

required

The organization display name.

Example:

"Acme"

onboarding

OrganizationOnboarding · object

required

Onboarding completion state.

Show child attributes

orgId

string

required

The organization id.

Example:

"org_2y8KqM4wXv1Z"

profile

OrganizationProfile · object

required

The company profile.

Show child attributes

tenantReady

boolean

required

Whether the organization is fully provisioned and active.

watchdog

OrganizationWatchdog · object

required

Deliverability watchdog settings.

Show child attributes

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

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

const { data, error } = await norbelys.organization.update({ alerts: { deliverability: true }, bouncePolicy: { stopOnSoftFailure: true, suppressOnSoftStop: true }, complete: true, profile: { industry: "B2B SaaS", teamSize: "2-10", website: "https://acme.com" } });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alerts": {
    "deliverability": true
  },
  "bouncePolicy": {
    "stopOnSoftFailure": true,
    "suppressOnSoftStop": true
  },
  "name": "Acme",
  "onboarding": {
    "completed": true,
    "completedAt": 1765432100000
  },
  "orgId": "org_2y8KqM4wXv1Z",
  "profile": {
    "industry": "B2B SaaS",
    "teamSize": "2-10",
    "website": "https://acme.com"
  },
  "tenantReady": true,
  "watchdog": {
    "enabled": true
  }
}

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

Update the organization

Authorizations

Body

Response