Rename an organization

patch /api/organizations/{id}

Rename an organization.

Updates an organization’s display name. Only owners can rename. The body is a JSON Merge Patch document.

Owners only

Renaming is restricted to organization owners. Members without the owner role receive a 403.

Path parameters

Name	Type	Required	Description
id	string	required	Organization identifier

Request body

Property	Type	Required	Description
name	string	-

Response

200 - Organization resource updated

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string | null	-
name	string	-
created_at	string	-
updated_at	string	-
owners	Member[]	-
Show owners fields Property Type Required Description @context object - @id string required @type string required id string - email string - name string | null - role string - joined_at string -
members	Member[]	-
Show members fields Property Type Required Description @context object - @id string required @type string required id string - email string - name string | null - role string - joined_at string -

Errors

400 - Invalid input

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

403 - Forbidden

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

404 - Not found

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

422 - An error occurred

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
status	integer	-
violations	object[]	-
Show violations fields Property Type Required Description propertyPath string required The property path of the violation message string required The message associated with the violation code string - The code of the violation hint string - An extra hint to understand the violation payload object - The serialized payload of the violation
detail	string	-
type	string	-
title	string | null	-
instance	string | null	-