PushizoDocs
API reference

feature-flags

feature-flags — 6 operations (GET /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags/evaluate, …). Generated from the OpenAPI 3.1.0 contract.

Base URL: https://api.pushizo.com · Tag: feature-flags · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/feature-flagsFeature flags
POST/v1/apps/{appId}/feature-flagsCreate a flag
POST/v1/apps/{appId}/feature-flags/evaluateEvaluate flags for a user
GET/v1/apps/{appId}/feature-flags/{flagId}Flag details
PATCH/v1/apps/{appId}/feature-flags/{flagId}Update a flag
DELETE/v1/apps/{appId}/feature-flags/{flagId}Delete a flag

Details

Feature flags

GET/v1/apps/{appId}/feature-flagsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AppFlagList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].keystringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].enabledbooleanYes
data[].value_typeenumYesValues: "boolean", "string", "number", "json"
data[].on_valueboolean | number | string | array<any> | map<string, any>Yes
data[].off_valueboolean | number | string | array<any> | map<string, any>Yes
data[].rollout_percentintegerYes
data[].segment_idstring | nullYes
data[].rollout_schedulearray<object>Yes
data[].rollout_schedule[].atstringYes
data[].rollout_schedule[].percentintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "enabled": true,
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "key": "key-2026-10",
      "description": "Sipariş durumu güncellemeleri",
      "value_type": "boolean",
      "on_value": true,
      "off_value": true,
      "rollout_percent": 1,
      "segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "rollout_schedule": [
        {
          "at": "örnek",
          "percent": 1
        }
      ],
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create a flag

POST/v1/apps/{appId}/feature-flagsTry it (interactive API docs, new tab)

Values can be read by anyone who knows the app ID; do not store secrets.

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateAppFlagDto

FieldTypeRequiredDescription
keystringYes
namestringYesLength: 1–100
descriptionstring | nullNo
enabledbooleanNo
value_typeenumNoValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>No
off_valueboolean | number | string | array<any> | map<string, any>No
rollout_percentintegerNoRange: 0–100
segment_idstring | nullNo
rollout_schedulearray<object>NoItems: 0–10
rollout_schedule[].atstring (date-time)Yes
rollout_schedule[].percentintegerYesRange: 0–100

Example:

{
  "name": "Sipariş bildirimleri",
  "key": "key-2026-10",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true,
  "off_value": true
}

Responses

201 — Success.

Schema: AppFlag

FieldTypeRequiredDescription
idstringYes
app_idstringYes
keystringYes
namestringYes
descriptionstring | nullYes
enabledbooleanYes
value_typeenumYesValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>Yes
off_valueboolean | number | string | array<any> | map<string, any>Yes
rollout_percentintegerYes
segment_idstring | nullYes
rollout_schedulearray<object>Yes
rollout_schedule[].atstringYes
rollout_schedule[].percentintegerYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "key": "key-2026-10",
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true,
  "off_value": true,
  "rollout_percent": 1,
  "segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "rollout_schedule": [
    {
      "at": "örnek",
      "percent": 1
    }
  ],
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "key": "key-2026-10",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true,
  "off_value": true
}'

Evaluate flags for a user

POST/v1/apps/{appId}/feature-flags/evaluateTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: EvaluateAppFlagsDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–255
user_idstringNoLength: 1–64
subjectstringNoLength: 1–128

Example:

{
  "external_id": "user_42",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject": "Siparişiniz yola çıktı"
}

Responses

200 — Success.

Schema: AppFlagEvaluation

FieldTypeRequiredDescription
flagsmap<string, object>Yes

Example response:

{
  "flags": {
    "key": {
      "enabled": true,
      "value": true,
      "reason": "on"
    }
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/evaluate" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_42",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject": "Siparişiniz yola çıktı"
}'

Flag details

GET/v1/apps/{appId}/feature-flags/{flagId}Try it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
flagIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AppFlag

FieldTypeRequiredDescription
idstringYes
app_idstringYes
keystringYes
namestringYes
descriptionstring | nullYes
enabledbooleanYes
value_typeenumYesValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>Yes
off_valueboolean | number | string | array<any> | map<string, any>Yes
rollout_percentintegerYes
segment_idstring | nullYes
rollout_schedulearray<object>Yes
rollout_schedule[].atstringYes
rollout_schedule[].percentintegerYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "key": "key-2026-10",
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true,
  "off_value": true,
  "rollout_percent": 1,
  "segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "rollout_schedule": [
    {
      "at": "örnek",
      "percent": 1
    }
  ],
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update a flag

PATCH/v1/apps/{appId}/feature-flags/{flagId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
flagIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAppFlagDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
descriptionstring | nullNo
enabledbooleanNo
value_typeenumNoValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>No
off_valueboolean | number | string | array<any> | map<string, any>No
rollout_percentintegerNoRange: 0–100
segment_idstring | nullNo
rollout_schedulearray<object>NoItems: 0–10
rollout_schedule[].atstring (date-time)Yes
rollout_schedule[].percentintegerYesRange: 0–100

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true
}

Responses

200 — Success.

Schema: AppFlag

FieldTypeRequiredDescription
idstringYes
app_idstringYes
keystringYes
namestringYes
descriptionstring | nullYes
enabledbooleanYes
value_typeenumYesValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>Yes
off_valueboolean | number | string | array<any> | map<string, any>Yes
rollout_percentintegerYes
segment_idstring | nullYes
rollout_schedulearray<object>Yes
rollout_schedule[].atstringYes
rollout_schedule[].percentintegerYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "key": "key-2026-10",
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true,
  "off_value": true,
  "rollout_percent": 1,
  "segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "rollout_schedule": [
    {
      "at": "örnek",
      "percent": 1
    }
  ],
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "value_type": "boolean",
  "on_value": true
}'

Delete a flag

DELETE/v1/apps/{appId}/feature-flags/{flagId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
flagIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page