organizations
organizations

put/api/organizations/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/organizations/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this organization.

Request body

idstring uuid required
namestring required
slugstring required
logo_media_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required
membership_level1 | 8 | 15 required
  • 1 - member
  • 8 - administrator
  • 15 - owner
membership_joined_atstring date-time nullable required

When the requesting user joined this organization. Null if the user is not a member.

plugins_access_level0 | 3 | 6 | 9 required
  • 0 - none
  • 3 - config
  • 6 - install
  • 9 - root
projectsobject[] required
is_member_join_email_enabledboolean required

Legacy field; member-join emails are controlled per user in account notification settings.

metadataobject required
customer_idstring nullable required
enforce_2faboolean nullable
enforce_verified_domainsboolean nullable

When True, logins, signups, and invites for this organization are restricted to email addresses on its verified domains.

members_can_inviteboolean nullable
members_can_create_projectsboolean nullable

When True, organization members (below admin) are allowed to create new projects. Admins and owners can always create projects.

members_can_use_personal_api_keysboolean
members_can_see_org_membersboolean

When False, members (below admin) only see themselves in the members list and only project members in access control.

allow_publicly_shared_resourcesboolean
read_only_mcp_accessboolean nullable

When True, requests through the PostHog MCP server can read but not change this organization's data.

member_countinteger required
is_ai_data_processing_approvedboolean nullable
is_ai_training_opted_inboolean nullable

When True, this organization allows its data to be used to train PostHog AI models.

is_ai_training_lockedboolean nullable required

When True, the AI training opt-out setting cannot be modified through the UI or API.

is_ai_training_cta_shownboolean nullable required

When True, in-app callouts inviting members to enable AI training are shown.

has_signed_baaboolean required

Whether the organization has a countersigned Business Associate Agreement on file. When true, AI training stays opted out and cannot be changed.

default_anonymize_ipsboolean

Default setting for 'Discard client IP data' for new projects in this organization.

default_role_idstring uuid nullable

ID of the role to automatically assign to new members joining the organization

is_activeboolean nullable required

Set this to 'No' to temporarily disable an organization.

is_not_active_reasonstring nullable required

(optional) reason for why the organization has been de-activated. This will be displayed to users on the web app.

is_pending_deletionboolean nullable required

Set to True when org deletion has been initiated. Blocks all UI access until the async task completes.

uses_most_specific_access_resolutionboolean nullable required

When True, access controls resolve with the most specific matching rule. When False, the legacy resolution order applies.

Response

idstring uuid required
namestring required
slugstring required
logo_media_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required
membership_level1 | 8 | 15 required
  • 1 - member
  • 8 - administrator
  • 15 - owner
membership_joined_atstring date-time nullable required

When the requesting user joined this organization. Null if the user is not a member.

plugins_access_level0 | 3 | 6 | 9 required
  • 0 - none
  • 3 - config
  • 6 - install
  • 9 - root
projectsobject[] required
is_member_join_email_enabledboolean required

Legacy field; member-join emails are controlled per user in account notification settings.

metadataobject required
customer_idstring nullable required
enforce_2faboolean nullable
enforce_verified_domainsboolean nullable

When True, logins, signups, and invites for this organization are restricted to email addresses on its verified domains.

members_can_inviteboolean nullable
members_can_create_projectsboolean nullable

When True, organization members (below admin) are allowed to create new projects. Admins and owners can always create projects.

members_can_use_personal_api_keysboolean
members_can_see_org_membersboolean

When False, members (below admin) only see themselves in the members list and only project members in access control.

allow_publicly_shared_resourcesboolean
read_only_mcp_accessboolean nullable

When True, requests through the PostHog MCP server can read but not change this organization's data.

member_countinteger required
is_ai_data_processing_approvedboolean nullable
is_ai_training_opted_inboolean nullable

When True, this organization allows its data to be used to train PostHog AI models.

is_ai_training_lockedboolean nullable required

When True, the AI training opt-out setting cannot be modified through the UI or API.

is_ai_training_cta_shownboolean nullable required

When True, in-app callouts inviting members to enable AI training are shown.

has_signed_baaboolean required

Whether the organization has a countersigned Business Associate Agreement on file. When true, AI training stays opted out and cannot be changed.

default_anonymize_ipsboolean

Default setting for 'Discard client IP data' for new projects in this organization.

default_role_idstring uuid nullable

ID of the role to automatically assign to new members joining the organization

is_activeboolean nullable required

Set this to 'No' to temporarily disable an organization.

is_not_active_reasonstring nullable required

(optional) reason for why the organization has been de-activated. This will be displayed to users on the web app.

is_pending_deletionboolean nullable required

Set to True when org deletion has been initiated. Blocks all UI access until the async task completes.

uses_most_specific_access_resolutionboolean nullable required

When True, access controls resolve with the most specific matching rule. When False, the legacy resolution order applies.

Changes

No recorded changes to this operation across all 1 revision of this API.