SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Plan, start, finish or dismiss an opportunity.

Move it through open, in_progress, won, lost or dismissed. Every change is recorded with who made it, so the board doubles as the record of what was tried. Marking something done does not itself prove it worked; the next monthly report measures that.

PATCHhttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/opportunities/{opportunity_id}

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

site_idstringrequired
opportunity_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

Where the work now stands.

reasonstring

Why, in a few words. Shown on the board.

Response

Response Body

opportunityobjectOne piece of work worth doing, scored and tracked across months. This is the unit the growth board is built from.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.seo.updateOpportunity('<site_id>', '<opportunity_id>', {
"status": "in_progress",
"reason": "Rewriting the page this sprint"
});
console.log(result);

Credentials

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

Response · 200

{
"data": {
"opportunity": {}
}
}