RankSharkDocs
Workflows

Validate a workflow

RankShark EnhanceScopecampaigns:read

POST
/api/v1/flows/validate

Checks a flow spec without saving anything.

Authorization

headerAuthorizationBearer <token>

An Enhance API key (rsen_…) or an OAuth 2.1 access token, as "Authorization: Bearer …".

Query Parameters

taskCount?integer

How many tasks[] the campaign has (mode nodes reference them by index)

Range1 <= value
Default1

Request Body

application/json
  1. body

A workflow (GET /api/v1/schema/flow documents nodes, edges and subflows; mode nodes reference tasks[] by index)

nodes*array<>
edges*array<>
subflows?
[key: string]?any

Response Body

The result (ok false with errors when it is not valid)

application/json
  1. response
ok*boolean
errors?array<string>

Blocking problems

warnings?array<string>
summary?
Example Request
curl -X POST 'https://panel.rankshark.io/api/v1/flows/validate' \  -H 'Content-Type: application/json' \  -d '{  "nodes": [    {}  ],  "edges": [    {}  ]}'
Example Response
{  "ok": true,  "errors": [    "string"  ],  "warnings": [    "string"  ],  "summary": {}}