Flows Api Service

Change flow status

Activating a flow requires its template to be available for the brand and the caller; deactivating one never does, so a running flow can always be switched off from its brand.

put/v2/flows/{id}/status

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/flows/{id}/status
  • Auth: none declared

Path parameters

idinteger required

Flow identifier

Request body

statusstring required

New flow status

Example request

{
  "status": "ACTIVE"
}

Response

Flow status changed successfully

metadataobject

Example response

{
  "data": {
    "id": 1001,
    "name": "Welcome DM on comment",
    "flowType": "COMMENT_WITH_KEYWORD",
    "socialNetwork": "INSTAGRAM",
    "status": "ACTIVE",
    "creatorUserId": 42,
    "creatorAgencyId": 10,
    "creatorAgencyUserId": 5,
    "profileConnected": true
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.