Skip to content
Docs

Update an Organization

PATCH/__remote/api.vercel.com/v1/organizations/{organizationId}
Update an organization's slug, name, or avatar. Upload avatar images through the existing files API before setting their hash. The organization avatar is independent of the root team's avatar. This endpoint is in private beta. Contact your Edgenivo account team for access.
/__remote/api.vercel.com/v1/organizations/{organizationId}
const response = await fetch('/__remote/api.vercel.com/v1/organizations/organizationId', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "avatar": "string",
    "name": "Example Name",
    "slug": "string"
  }),
});


const data = await response.json();
console.log(data);
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

Path parameters

organizationIdstringRequired
The ID of the organization to update.

Body

application/json
avatarstringOptional
The hash value of an uploaded image, or null to clear the organization avatar. Omit to leave it unchanged.
namestringOptional
The new display name for the organization.
slugstringOptional
The new slug for the organization.

Response

200Success
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.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error