SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
seo

Update a prospect: status, contact, owner, notes or follow-up date.

Update a prospect: status, contact, owner, notes or follow-up date.

PATCHhttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/link-prospects/{prospect_id}

Recent Requests

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

Path Params

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

source_urlstring

Page you want a link from.

target_urlstring

Page on the site the link should point to.

contact_namestring

Who to ask.

contact_emailstring

Their email.

suggested_anchorstring

Anchor text to ask for.

statusstring

Outreach state.

owner_user_idinteger

Member who owns the outreach.

notesstring

Free-text notes.

next_follow_up_onstring

Date of the next follow-up (YYYY-MM-DD).

Response

Response Body

idstringProspect id. Use it as prospect_id.
source_urlstringPage you want a link from.
source_domainstringDomain of that page.
contact_namestring | nullWho to ask.
contact_emailstring | nullTheir email.
target_urlstring | nullPage on the site the link should point to.
suggested_anchorstring | nullAnchor text to ask for.
statusstringOutreach state.
owner_user_idinteger | nullMember chasing it.
notesstring | nullFree-text notes.
next_follow_up_onstring | nullDate of the next follow-up.
last_verified_atstring | nullLast time the page was checked for the link.
verification_statusstring | nullResult of the last check.
backlink_idstring | nullBacklink created once the link went live.
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.updateSiteLinkProspect('<site_id>', '<prospect_id>', {});
console.log(result);

Credentials

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

Response · 200

{
  "data": {
    "id": "string",
    "source_url": "string",
    "source_domain": "string",
    "contact_name": "string",
    "contact_email": "string",
    "target_url": "string",
    "suggested_anchor": "string",
    "status": "string",
    "owner_user_id": 0,
    "notes": "string",
    "next_follow_up_on": "string",
    "last_verified_at": "string",
    "verification_status": "string",
    "backlink_id": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}