Discovery jobs
Start prospect discovery
Requires the prospects:write scope. Discovery runs asynchronously.
Requires the prospects:write scope. Discovery runs asynchronously.
Authorization
bearerAuth AuthorizationBearer <token>
Use a token created in Settings → API access.
In: header
Path Parameters
workspaceId*string
Workspace ID returned by GET /workspaces.
siteId*string
Site ID returned by GET /workspaces/{workspaceId}/sites.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
goal?string
Value in
- "all"
- "editorial_outreach"
- "paid_placements"
selectedKeywords?array<string>
Items
items <= 10confirmedKeywords?array<string>
Items
2 <= items <= 2refresh?boolean
Default
falserequestKey?string
Required when refresh is true; reuse it to safely retry the request.
Length
8 <= length <= 160Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/workspaces/string/sites/string/discovery-jobs" \ -H "Content-Type: application/json" \ -d '{}'{ "ok": true, "data": { "jobId": "string", "status": "string" }}