SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

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

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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 stringsrequired

Prospect ids to add, from GET /sites/{site_id}/link-prospects.

Response

Response Body

bookobjectThe contact book the prospects were added to.
prospectsintegerHow many were added.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/link-prospects/outreach \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"5c1e9a2b-7d4f-4e3a-8b6c-0f1e2d3c4b5a"
]
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

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