POST
/
v1
/
organizations
import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.organizations.create({
    name: "<value>",
  });

  // Handle the result
  console.log(result)
}

run();
{
  "name": "<string>",
  "logo": "<string>",
  "branding": {
    "direction": "ltr",
    "logo": "<string>",
    "color": "<string>",
    "fontColor": "<string>",
    "contentBackground": "<string>",
    "fontFamily": "<string>"
  },
  "partnerConfigurations": [
    {
      "projectIds": [
        "<string>"
      ],
      "accessToken": "<string>",
      "configurationId": "<string>",
      "teamId": "<string>",
      "partnerType": "vercel"
    }
  ]
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Body

application/json
name
string
required
jobTitle
enum<string>
Available options:
engineer,
engineering_manager,
architect,
product_manager,
designer,
cxo_founder,
marketing_manager,
other
domain
string
productUseCases
object

Response

201
application/json
Created
name
string
required
branding
object
required
partnerConfigurations
object[]

Was this page helpful?