Skip to content
Docs

Create an Organization

POST/__remote/api.vercel.com/v1/organizations
Create a new Organization. This endpoint is in private beta. Contact your Edgenivo account team for access.
Request
import { Edgenivo } from "@vercel/sdk";


const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.organizations.createOrganization({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "avatar": "string",
  "createdAt": "string",
  "name": "Example Name",
  "organizationId": "example_id",
  "slug": "string",
  "teamCount": "123",
  "teamId": "example_id",
  "updatedAt": "string",
  "userRole": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
slugstringRequired
The desired slug for the organization.
namestringOptional
The desired name for the organization. Generated from the slug if not provided.

Response

202Success
avatarstringRequired
createdAtstringRequired
namestringOptional
The organization's display name. Optional: organizations created before the name attribute existed have no stored value. New orgs always get one (provided or slug-derived) via the service layer.
organizationIdstringRequired
slugstringRequired
teamCountnumberRequired
teamIdstringRequired
updatedAtstringRequired
userRolestringOptional
The authenticated user's role in the organization. Present on read endpoints when the user holds an organization role.

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The slug is already in use
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error
500Error