Skip to main content
POST
Create a manual action

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Idempotency-Key
string<uuid>

Body

application/json
category
enum<string>
required

Which of the three Actions cards the action sits under: content (Content gaps), website (Website audit) or backlink (Backlink opportunities). A manual action picks one when it is created. Not the same as source, which is where the finding came from.

Available options:
content,
website,
backlink
title
string
required
Required string length: 1 - 300
description
string
default:""
Maximum string length: 10000
targetUrl
string<uri> | null
Maximum string length: 2048
steps
string[]
Maximum array length: 100
Required string length: 1 - 2000

Response

The created (or replayed) action

data
object
required