STstatsig
Segments

Commit Segment Review

Changed on
put/console/v1/segments/{id}/reviews/{reviewID}/commit

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/segments/{id}/reviews/{reviewID}/commit
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required
reviewIDstring required

Request body

bypass_webhookboolean

Skip the configured pre-commit webhook and apply the reviewed change immediately. Personal keys require the bypass_precommit_webhook permission. An omitted value bypasses automatically for ownerless omni_read_write Console API keys; set to false to run the configured webhook workflow.

Response

Commit a segment review. Unless bypass_webhook is authorized, a configured pre-commit webhook must validate the review before a later commit applies the change.

messagestring required
status'pending_webhook_validation' | 'failed_webhook_validation' | 'approved_webhook_validation' | 'committed' required

Current review status after the commit attempt. A non-final webhook status means the reviewed change was not applied.

Changes

  • e0f8326bc423Revision changes
    • info

      added optional request body

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status