Add prospects to an Outreach contact book so the team can write to them.

Requires the Outreach service (402 service_not_active); a connected member must hold service.outreach.contact_books.manage (403 otherwise). Only open prospects (not contacted, contacted or replied) with a contact email are added. Their status is not changed.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_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

idsarray of strings

Prospect ids to add.

Response

Response Body

bookobjectThe contact book the prospects were added to.

prospectsintegerHow many were added.

Request

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

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

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

Credentials

Authorization

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

Response · 201

{
  "data": {
    "book": {},
    "prospects": 0
  }
}