Mark a mention as ignored, new or prospected.

PATCHhttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/mentions/{mention_id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

mention_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, ignored or prospected.

Response

Response Body

idstringMention id. Use it as mention_id.

page_urlstringPage that mentions the brand.

page_domainstringDomain of that page.

page_titlestring | nullTitle of that page.

matched_phrasestringBrand phrase that was found.

context_textstring | nullSentence around the mention.

links_to_sitebooleanWhether the page already links to the site.

statusstringnew, linked, ignored or prospected.

prospect_idstring | nullProspect created from it, when one was.

first_seen_atstringWhen it was found.

verified_atstring | nullWhen the page text was confirmed.

Request

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

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

const result = await client.seo.updateSiteMention('<site_id>', '<mention_id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "id": "string",
    "page_url": "string",
    "page_domain": "string",
    "page_title": "string",
    "matched_phrase": "string",
    "context_text": "string",
    "links_to_site": true,
    "status": "string",
    "prospect_id": "string",
    "first_seen_at": "string",
    "verified_at": "string"
  }
}