Accept, dismiss or reopen a recommendation.

Only change status when the user asked for it. Creating tasks from recommendations stays in the dashboard.

PATCHhttps://app.softsolz.uk/api/v1/services/seo/recommendations/{recommendation_id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

recommendation_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

statusstring

New status.

reasonstring

Why, recorded when dismissing.

Response

Response Body

idstringRecommendation id.

run_idstringReport the recommendation belongs to.

playstringWhich playbook produced it. external_suggestion for recommendations written through the API.

titlestringOne-line action.

detail_markdownstring | nullWhy and how, in Markdown.

priority_rankinteger | null1 is the most valuable recommendation in the report.

priority_scorenumberScore the rank was derived from.

estimated_effortstringRough effort.

opportunity_clicksnumberMonthly clicks at stake if the recommendation is acted on.

statusstringDecision state.

dismissed_reasonstring | nullWhy it was dismissed, when it was.

task_idstring | nullTask created from it, when one was.

finding_idsarray of stringsFindings the recommendation is built on.

sourcestringdetector when SoftSolz produced it, api when a connected app did.

author_labelstring | nullName of the app or key that wrote it.

created_atstringCreation time.

updated_atstringLast change.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.updateRecommendation('<recommendation_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "run_id": "string",
    "play": "string",
    "title": "string",
    "detail_markdown": "string",
    "priority_rank": 0,
    "priority_score": 0,
    "estimated_effort": "string",
    "opportunity_clicks": 0,
    "status": "string",
    "dismissed_reason": "string",
    "task_id": "string",
    "finding_ids": [],
    "source": "string",
    "author_label": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}