v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Organizations

Update an Organization

Update various attributes and configurable settings for the given organization.

put/api/0/organizations/{organization_id_or_slug}/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

Request body

slugstring

The new slug for the organization, which needs to be unique.

namestring

The new name for the organization.

isEarlyAdopterboolean

Specify true to opt-in to new features before they're released to the public.

hideAiFeaturesboolean

Specify true to hide AI features from the organization.

defaultRole'member' | 'admin' | 'manager' | 'owner'

The default role new members will receive.

  • member - Member
  • admin - Admin
  • manager - Manager
  • owner - Owner
openMembershipboolean

Specify true to allow organization members to freely join any team.

eventsMemberAdminboolean

Specify true to allow members to delete events (including the delete & discard action) by granting them the event:admin scope.

alertsMemberWriteboolean

Specify true to allow members to create, edit, and delete alert rules by granting them the alerts:write scope.

attachmentsRole'member' | 'admin' | 'manager' | 'owner'

The role required to download event attachments, such as native crash reports or log files.

  • member - Member
  • admin - Admin
  • manager - Manager
  • owner - Owner
debugFilesRole'member' | 'admin' | 'manager' | 'owner'

The role required to download debug information files, ProGuard mappings and source maps.

  • member - Member
  • admin - Admin
  • manager - Manager
  • owner - Owner
hasGranularReplayPermissionsboolean

Specify true to enable granular replay permissions, allowing per-member access control for replay data.

replayAccessMembersinteger[] nullable

A list of user IDs who have permission to access replay data. Requires the hasGranularReplayPermissions flag to be true to be enforced.

avatarType'letter_avatar' | 'upload'

The type of display picture for the organization.

  • letter_avatar - Use initials
  • upload - Upload an image
avatarstring

The image to upload as the organization avatar, in base64. Required if avatarType is upload.

require2FAboolean

Specify true to require and enforce two-factor authentication for all members.

allowSharedIssuesboolean

Specify true to allow sharing of limited details on issues to anonymous users.

enhancedPrivacyboolean

Specify true to enable enhanced privacy controls to limit personally identifiable information (PII) as well as source code in things like notifications.

scrapeJavaScriptboolean

Specify true to allow Sentry to scrape missing JavaScript source context when possible.

storeCrashReports0 | 1 | 5 | 10 | 20 | 50 | 100 | -1

How many native crash reports (such as Minidumps for improved processing and download in issue details) to store per issue.

  • 0 - Disabled
  • 1 - 1 per issue
  • 5 - 5 per issue
  • 10 - 10 per issue
  • 20 - 20 per issue
  • 50 - 50 per issue
  • 100 - 100 per issue
  • -1 - Unlimited
allowJoinRequestsboolean

Specify true to allow users to request to join your organization.

dataScrubberboolean

Specify true to require server-side data scrubbing for all projects.

dataScrubberDefaultsboolean

Specify true to apply the default scrubbers to prevent things like passwords and credit cards from being stored for all projects.

sensitiveFieldsstring[]

A list of additional global field names to match against when scrubbing data for all projects.

safeFieldsstring[]

A list of global field names which data scrubbers should ignore.

scrubIPAddressesboolean

Specify true to prevent IP addresses from being stored for new events on all projects.

relayPiiConfigstring

Advanced data scrubbing rules that can be configured for each project as a JSON string. The new rules will only apply to new incoming events. For more details on advanced data scrubbing, see our full documentation.

Warning: Calling this endpoint with this field fully overwrites the advanced data scrubbing rules.

Below is an example of a payload for a set of advanced data scrubbing rules for masking credit card numbers from the log message (equivalent to [Mask] [Credit card numbers] from [$message] in the Sentry app) and removing a specific key called foo (equivalent to [Remove] [Anything] from [extra.foo] in the Sentry app):

{
    relayPiiConfig: "{\"rules":{\"0\":{\"type\":\"creditcard\",\"redaction\":{\"method\":\"mask\"}},\"1\":{\"type\":\"anything\",\"redaction\":{\"method\":\"remove\"}}},\"applications\":{\"$message\":[\"0\"],\"extra.foo\":[\"1\"]}}"
}
trustedRelaysobject[]

A list of local Relays (the name, public key, and description as a JSON) registered for the organization. This feature is only available for organizations on the Business and Enterprise plans. Read more about Relay here.

                                      Below is an example of a list containing a single local Relay registered for the organization:
                                      ```json
                                      {
                                        trustedRelays: [
                                            {
                                                name: "my-relay",
                                                publicKey: "eiwr9fdruw4erfh892qy4493reyf89ur34wefd90h",
                                                description: "Configuration for my-relay."
                                            }
                                        ]
                                      }
                                      ```
                                      
relayDsnEndpointstring nullable

A Relay base URL to use when displaying Client Key DSNs for this organization.

issueAlertsThreadFlagboolean

Specify true to allow the Sentry Slack integration to post replies in threads for an Issue Alert notification. Requires a Slack integration.

metricAlertsThreadFlagboolean

Specify true to allow the Sentry Slack integration to post replies in threads for a Metric Alert notification. Requires a Slack integration.

cancelDeletionboolean

Specify true to restore an organization that is pending deletion.

Response

featuresstring[]
extraOptionsobject
accessstring[]
idstring required
slugstring required
namestring required
dateCreatedstring date-time required
isEarlyAdopterboolean required
require2FAboolean required
hasAuthProviderboolean required
allowMemberInviteboolean required
allowMemberProjectCreationboolean required
allowSuperuserAccessboolean required
{"stackTrail":"paths:/api/0/organizations/{organization_id_or_slug}/:put:responses:200:content:application/json:schema:properties:role","oasType":"schema","type":"unknown"}
orgRolestring
targetSampleRatenumber double
samplingModestring
planSampleRatenumber double
desiredSampleRatenumber double
experimentsobject required
isDefaultboolean required
defaultRolestring required
openMembershipboolean required
allowSharedIssuesboolean required
enhancedPrivacyboolean required
dataScrubberboolean required
dataScrubberDefaultsboolean required
sensitiveFieldsstring[] required
safeFieldsstring[] required
storeCrashReportsinteger required
attachmentsRolestring required
debugFilesRolestring required
eventsMemberAdminboolean required
alertsMemberWriteboolean required
scrubIPAddressesboolean required
scrapeJavaScriptboolean required
allowJoinRequestsboolean required
relayPiiConfigstring nullable required
relayDsnEndpointstring nullable required
pendingAccessRequestsinteger required
hideAiFeaturesboolean required
aggregatedDataConsentboolean required
isDynamicallySampledboolean required
issueAlertsThreadFlagboolean required
metricAlertsThreadFlagboolean required
requiresSsoboolean required
defaultAutofixAutomationTuningstring required
defaultSeerScannerAutomationboolean required
enableSeerCodingboolean required
defaultCodingAgentstring required
defaultCodingAgentIntegrationIdstring nullable required
defaultAutomatedRunStoppingPointstring required
autoEnableCodeReviewboolean required
autoOpenPrsboolean required
defaultCodeReviewTriggersstring[] required