Flows Api Service

Create a new flow

post/v2/flows

Request

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

Request body

namestring required

Flow name

flowTypestring required

Type of flow

socialNetworkstring required

Social network for the flow

statusstring required

Initial flow status

triggerConfigobject required

Trigger configuration defining when the flow is activated

actionsConfigobject required

Actions configuration defining what the flow does when triggered

Example request

{
  "name": "Welcome DM on comment",
  "flowType": "COMMENT_WITH_KEYWORD",
  "socialNetwork": "INSTAGRAM",
  "status": "INACTIVE"
}

Response

Flow created 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 4 revisions of this API.