Skip to main content
Version: 24.05

Update flow disabled status

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint​

/i/flows/updateDisabled

Overview​

Bulk-updates the disabled flag for multiple flows.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

Requires flows Create permission for this endpoint.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
dataJSON String (Object)YesObject mapping flow_id -> true/false.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Examples​

Disable two flows​

/i/flows/updateDisabled?
app_id=64f5c0d8f4f7ac0012ab3456&
data={
"64f5c0d8f4f7ac0012ab3456_67bd31c92e7f0b0012ab4567": true,
"64f5c0d8f4f7ac0012ab3456_67bd31c92e7f0b0012ab4568": true
}

Re-enable one flow​

/i/flows/updateDisabled?
app_id=64f5c0d8f4f7ac0012ab3456&
data={
"64f5c0d8f4f7ac0012ab4567": false
}

Response​

Success Response​

{
"result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringSuccess when bulk update executes.

Error Responses​

  • 400
{
"result": "Nothing to update"
}
  • 400
{
"result": "<bulk update error object or message>"
}
  • 500
{
"result": "Invalid paramerer 'data'"
}

Behavior​

  • Parses data JSON object.
  • Builds bulk update operations in flow_schemas by _id and app_id.
  • Sets disabled=true only when value is literal true or string "true"; otherwise sets false.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.flow_schemasEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.