Sign in
Organizations

Update an organization

Updates an existing organization

patch/organizations/{organization_id}

Path parameters

organization_idstring required

The ID of the organization to update

Request body

public_metadataobject nullable

Metadata saved on the organization, that is visible to both your frontend and backend.

private_metadataobject nullable

Metadata saved on the organization that is only visible to your backend.

namestring nullable

The new name of the organization. May not contain URLs or HTML. Max length: 256

slugstring nullable

The new slug of the organization, which needs to be unique in the instance

max_allowed_membershipsinteger nullable

The maximum number of memberships allowed for this organization

admin_delete_enabledboolean nullable

If true, an admin can delete this organization with the Frontend API.

created_atstring nullable

A custom date/time denoting when the organization was created, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).

role_set_keystring nullable

The key of the role set to assign to this organization.

Response

An organization

object'organization' required
idstring required
namestring required
slugstring required
image_urlstring
has_imageboolean required
members_countinteger
missing_member_with_elevated_permissionsboolean
pending_invitations_countinteger
max_allowed_membershipsinteger required
admin_delete_enabledboolean required
public_metadataobject required
private_metadataobject
created_bystring
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

last_active_atinteger

Unix timestamp of last activity.

role_set_keystring nullable

The key of the role set assigned to this organization.

Changes