organizations

Update an Organization

Changed on

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 Vercel account team for access.

patch/v1/organizations/{organizationId}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/organizations/{organizationId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

The ID of the organization to update.

Request body

avatarstring nullable

The hash value of an uploaded image, or null to clear the organization avatar. Omit to leave it unchanged.

namestring

The new display name for the organization.

slugstring

The new slug for the organization.

Response

avatarstring nullable required
createdAtstring required
namestring

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.

organizationIdstring required
slugstring required
teamCountnumber required
teamIdstring required
updatedAtstring required
userRolestring

The authenticated user's role in the organization. Present on read endpoints when the user holds an organization role.

Changes