Skip to main content

Function: updateOrg()

updateOrg(client, props): Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; location: string; createdAt: string; updatedAt: string; isPersonalOrg: boolean; socialLinks: object[]; }>

Updates an organization's metadata.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; } = updateOrgParamsSchema

Path parameters (orgName)

params.orgName​

string = orgNameSchema

body​

{ name?: string; description?: string; location?: string; visibility?: "PRIVATE" | "PUBLIC"; socialLinks?: object[]; } = updateOrgBodySchema

Request body with fields to update

body.name?​

string = ...

body.description?​

string = ...

body.location?​

string = ...

body.visibility?​

"PRIVATE" | "PUBLIC" = ...

object[] = ...

Returns​

Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; location: string; createdAt: string; updatedAt: string; isPersonalOrg: boolean; socialLinks: object[]; }>

Promise resolving to the updated organization

Operation Id​

update-org

Example​

const org = await updateOrg(client, {
  params: { orgName: 'my-org' },
  body: { description: 'Updated description', location: 'San Francisco' }
});