Organizations-3
For instructions on how to authenticate to use this endpoint, see API overview.
Projects for the current organization.
Endpoints
Update partial update
Required API key scopes
project:write
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Request parameters
- namestring
- product_descriptionstring
- app_urlsarray
- slack_incoming_webhookstring
- anonymize_ipsboolean
- completed_snippet_onboardingboolean
- test_account_filters
- test_account_filters_default_checkedboolean
- path_cleaning_filters
- is_demoboolean
- timezone
- data_attributes
- person_display_name_propertiesarray
- correlation_config
- autocapture_opt_outboolean
- autocapture_exceptions_opt_inboolean
- autocapture_web_vitals_opt_inboolean
- autocapture_web_vitals_allowed_metrics
- autocapture_exceptions_errors_to_ignore
- capture_console_log_opt_inboolean
- capture_performance_opt_inboolean
- session_recording_opt_inboolean
- session_recording_sample_ratestring
- session_recording_minimum_duration_millisecondsinteger
- session_recording_linked_flag
- session_recording_network_payload_capture_config
- session_replay_config
- survey_config
- access_controlboolean
- week_start_day
- primary_dashboardinteger
- live_events_columnsarray
- recording_domainsarray
- inject_web_appsboolean
- extra_settings
- modifiers
- has_completed_onboarding_for
- surveys_opt_inboolean
- heatmaps_opt_inboolean
Response
Request
PATCH
/api /organizations /:organization_id /projects /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/\-d organization="string"
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
Delete destroy
Required API key scopes
project:write
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Request
DELETE
/api /organizations /:organization_id /projects /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/
Response
Status 204 No response body
Retrieve activity
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Response
Request
GET
/api /organizations /:organization_id /projects /:id /activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/activity/
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
Update add product intent
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Request parameters
- namestring
- product_descriptionstring
- app_urlsarray
- slack_incoming_webhookstring
- anonymize_ipsboolean
- completed_snippet_onboardingboolean
- test_account_filters
- test_account_filters_default_checkedboolean
- path_cleaning_filters
- is_demoboolean
- timezone
- data_attributes
- person_display_name_propertiesarray
- correlation_config
- autocapture_opt_outboolean
- autocapture_exceptions_opt_inboolean
- autocapture_web_vitals_opt_inboolean
- autocapture_web_vitals_allowed_metrics
- autocapture_exceptions_errors_to_ignore
- capture_console_log_opt_inboolean
- capture_performance_opt_inboolean
- session_recording_opt_inboolean
- session_recording_sample_ratestring
- session_recording_minimum_duration_millisecondsinteger
- session_recording_linked_flag
- session_recording_network_payload_capture_config
- session_replay_config
- survey_config
- access_controlboolean
- week_start_day
- primary_dashboardinteger
- live_events_columnsarray
- recording_domainsarray
- inject_web_appsboolean
- extra_settings
- modifiers
- has_completed_onboarding_for
- surveys_opt_inboolean
- heatmaps_opt_inboolean
Response
Request
PATCH
/api /organizations /:organization_id /projects /:id /add_product_intent
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/add_product_intent/\-d organization="string"
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
Update complete product onboarding
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Request parameters
- namestring
- product_descriptionstring
- app_urlsarray
- slack_incoming_webhookstring
- anonymize_ipsboolean
- completed_snippet_onboardingboolean
- test_account_filters
- test_account_filters_default_checkedboolean
- path_cleaning_filters
- is_demoboolean
- timezone
- data_attributes
- person_display_name_propertiesarray
- correlation_config
- autocapture_opt_outboolean
- autocapture_exceptions_opt_inboolean
- autocapture_web_vitals_opt_inboolean
- autocapture_web_vitals_allowed_metrics
- autocapture_exceptions_errors_to_ignore
- capture_console_log_opt_inboolean
- capture_performance_opt_inboolean
- session_recording_opt_inboolean
- session_recording_sample_ratestring
- session_recording_minimum_duration_millisecondsinteger
- session_recording_linked_flag
- session_recording_network_payload_capture_config
- session_replay_config
- survey_config
- access_controlboolean
- week_start_day
- primary_dashboardinteger
- live_events_columnsarray
- recording_domainsarray
- inject_web_appsboolean
- extra_settings
- modifiers
- has_completed_onboarding_for
- surveys_opt_inboolean
- heatmaps_opt_inboolean
Response
Request
PATCH
/api /organizations /:organization_id /projects /:id /complete_product_onboarding
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/complete_product_onboarding/\-d organization="string"
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
Retrieve is generating demo data
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Response
Request
GET
/api /organizations /:organization_id /projects /:id /is_generating_demo_data
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/is_generating_demo_data/
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
Update reset token
Path parameters
- idinteger
A unique value identifying this project.
- organization_idstring
Request parameters
- namestring
- product_descriptionstring
- app_urlsarray
- slack_incoming_webhookstring
- anonymize_ipsboolean
- completed_snippet_onboardingboolean
- test_account_filters
- test_account_filters_default_checkedboolean
- path_cleaning_filters
- is_demoboolean
- timezone
- data_attributes
- person_display_name_propertiesarray
- correlation_config
- autocapture_opt_outboolean
- autocapture_exceptions_opt_inboolean
- autocapture_web_vitals_opt_inboolean
- autocapture_web_vitals_allowed_metrics
- autocapture_exceptions_errors_to_ignore
- capture_console_log_opt_inboolean
- capture_performance_opt_inboolean
- session_recording_opt_inboolean
- session_recording_sample_ratestring
- session_recording_minimum_duration_millisecondsinteger
- session_recording_linked_flag
- session_recording_network_payload_capture_config
- session_replay_config
- survey_config
- access_controlboolean
- week_start_day
- primary_dashboardinteger
- live_events_columnsarray
- recording_domainsarray
- inject_web_appsboolean
- extra_settings
- modifiers
- has_completed_onboarding_for
- surveys_opt_inboolean
- heatmaps_opt_inboolean
Response
Request
PATCH
/api /organizations /:organization_id /projects /:id /reset_token
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/projects/:id/reset_token/\-d organization="string"
Response
Status 200
RESPONSE
{"id": 0,"organization": "452c1a86-a0af-475b-b03f-724878b0f387","name": "string","product_description": "string","created_at": "2019-08-24T14:15:22Z","effective_membership_level": 1,"has_group_types": true,"live_events_token": "string","updated_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","api_token": "string","app_urls": ["string"],"slack_incoming_webhook": "string","anonymize_ips": true,"completed_snippet_onboarding": true,"ingested_event": true,"test_account_filters": null,"test_account_filters_default_checked": true,"path_cleaning_filters": null,"is_demo": true,"timezone": "Africa/Abidjan","data_attributes": null,"person_display_name_properties": ["string"],"correlation_config": null,"autocapture_opt_out": true,"autocapture_exceptions_opt_in": true,"autocapture_web_vitals_opt_in": true,"autocapture_web_vitals_allowed_metrics": null,"autocapture_exceptions_errors_to_ignore": null,"capture_console_log_opt_in": true,"capture_performance_opt_in": true,"session_recording_opt_in": true,"session_recording_sample_rate": "string","session_recording_minimum_duration_milliseconds": 15000,"session_recording_linked_flag": null,"session_recording_network_payload_capture_config": null,"session_replay_config": null,"survey_config": null,"access_control": true,"week_start_day": 0,"primary_dashboard": 0,"live_events_columns": ["string"],"recording_domains": ["string"],"person_on_events_querying_enabled": "string","inject_web_apps": true,"extra_settings": null,"modifiers": null,"default_modifiers": "string","has_completed_onboarding_for": null,"surveys_opt_in": true,"heatmaps_opt_in": true,"product_intents": "string"}
List all proxy records
Required API key scopes
organization:read
Path parameters
- organization_idstring
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /organizations /:organization_id /proxy_records
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/proxy_records/
Response
Status 200
RESPONSE
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","domain": "string","target_cname": "string","status": "waiting","message": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","created_by": 0}]}
Create proxy records
Required API key scopes
organization:write
Path parameters
- organization_idstring
Request parameters
- domainstring
Response
Request
POST
/api /organizations /:organization_id /proxy_records
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/proxy_records/\-d domain="string"
Response
Status 201
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","domain": "string","target_cname": "string","status": "waiting","message": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","created_by": 0}
Retrieve proxy records
Required API key scopes
organization:read
Path parameters
- idstring
- organization_idstring
Response
Request
GET
/api /organizations /:organization_id /proxy_records /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/proxy_records/:id/
Response
Status 200
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","domain": "string","target_cname": "string","status": "waiting","message": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","created_by": 0}
Update proxy records
Required API key scopes
organization:write
Path parameters
- idstring
- organization_idstring
Request parameters
- domainstring
Response
Request
PATCH
/api /organizations /:organization_id /proxy_records /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/proxy_records/:id/\-d domain="string"
Response
Status 200
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","domain": "string","target_cname": "string","status": "waiting","message": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","created_by": 0}
Delete proxy records
Required API key scopes
organization:write
Path parameters
- idstring
- organization_idstring
Request
DELETE
/api /organizations /:organization_id /proxy_records /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/proxy_records/:id/
Response
Status 204 No response body
List all roles
Required API key scopes
organization:read
Path parameters
- organization_idstring
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /organizations /:organization_id /roles
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/roles/
Response
Status 200
RESPONSE
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","feature_flags_access_level": 21,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","last_name": "string","email": "user@example.com","is_email_verified": true,"hedgehog_config": {"property1": null,"property2": null}},"members": "string","associated_flags": "string"}]}
Create roles
Required API key scopes
organization:write
Path parameters
- organization_idstring
Request parameters
- namestring
- feature_flags_access_level
Response
Request
POST
/api /organizations /:organization_id /roles
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/roles/\-d name="string"
Response
Status 201
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","feature_flags_access_level": 21,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","last_name": "string","email": "user@example.com","is_email_verified": true,"hedgehog_config": {"property1": null,"property2": null}},"members": "string","associated_flags": "string"}
Retrieve roles
Required API key scopes
organization:read
Path parameters
- idstring
A UUID string identifying this role.
- organization_idstring
Response
Request
GET
/api /organizations /:organization_id /roles /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/roles/:id/
Response
Status 200
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","feature_flags_access_level": 21,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","last_name": "string","email": "user@example.com","is_email_verified": true,"hedgehog_config": {"property1": null,"property2": null}},"members": "string","associated_flags": "string"}
Update roles
Required API key scopes
organization:write
Path parameters
- idstring
A UUID string identifying this role.
- organization_idstring
Request parameters
- namestring
- feature_flags_access_level
Response
Request
PATCH
/api /organizations /:organization_id /roles /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/roles/:id/\-d name="string"
Response
Status 200
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","feature_flags_access_level": 21,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","last_name": "string","email": "user@example.com","is_email_verified": true,"hedgehog_config": {"property1": null,"property2": null}},"members": "string","associated_flags": "string"}
Delete roles
Required API key scopes
organization:write
Path parameters
- idstring
A UUID string identifying this role.
- organization_idstring
Request
DELETE
/api /organizations /:organization_id /roles /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/organizations/:organization_id/roles/:id/