Delete a Single Gate User ID Override

Removes a single user ID from the matching pass/fail userID override bucket on the gate. Idempotent: returns 200 even when the user ID is not currently overr…

Removes a single user ID from the matching pass/fail userID override bucket on the gate. Idempotent: returns 200 even when the user ID is not currently overridden. Only clears the all-environments userID bucket; environment-scoped and custom-ID overrides are left untouched.

deletehttps://statsigapi.net/console/v1/gates/{id}/overrides/userID/{userID}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Gate name

userIDstringrequired

User ID to remove from the override

Query parameters

groupIDstringrequired

Whether the user ID was overridden to pass or fail the gate.

Allowed values:passfail

Response

application/json
201· Delete Single Gate User ID Override Success
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Contract for overrides

Show child attributes
passingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
failingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
passingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
failingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
environmentOverridesobject[]required
environmentstring

Environment

Example:staging
Constraints:nullable
unitIDstringrequired

Unit ID

Example:unit123
Constraints:nullable
passingIDsstring[]required

List of passing IDs

Example:["id1","id2"]
failingIDsstring[]required

List of failing IDs

Example:["id3","id4"]
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired
404· Gate not found.
statusintegerrequired
Allowed values:404
messagestringrequired

Was this helpful?