Skip to content
ProspectAPIs

API reference / People writes

Endorse a skill

Written and maintained by The ProspectAPIs team

POST/v1/people/endorse

POST /v1/people/endorse is the ProspectAPIs operation endorseSkill, in the People writes group of the REST API. Endorse one of a person's listed skills, named as GET /v1/people/skills lists it. $0.005 per action. A skill you already endorsed answers already: true with nothing sent again. Acts on your own connected account (connect one first with POST /v1/accounts/session). Billed per call once the write product is live; while it is not yet on sale the call is free (GET /pricing reports people_writes.available). While GET /pricing does not list this route in people_writes.available_routes it answers 503 temporarily_unavailable and nothing is charged. Cost: Not available yet. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

Parameters of POST /v1/people/endorse
NameInTypeDescription
Idempotency-KeyheaderstringOptional, 1 to 255 printable ASCII characters. A retry with the same key and body within 24 hours gets the first answer back with Idempotent-Replayed: true and is never charged again. The same key with a different body is 422; a retry while the first call is still running is 409.

Request body

JSON. Give the person_ref and the skill name.

Request body of POST /v1/people/endorse
FieldTypeDescription
person_ref requiredstringThe person reference from a profile or search result. At most 4000 characters.
skill requiredstringThe skill name, as GET /v1/people/skills lists it. At most 100 characters.
Example body
{
  "person_ref": "person ref",
  "skill": "skill"
}

Responses

Response codes of POST /v1/people/endorse
StatusMeaning
200Done. Our neutral confirmation.
202Your connected account is signed out or needs a reconnect: the write is queued and sent, through the same pacing, once the account is connected again. Charged only when sent. See GET /v1/writes/queued.
400The request was invalid (e.g. a bad filter or input); nothing was charged.
401The API key is missing or invalid.
402Out of credits. The body carries top_up_url; nothing was charged.
403The connected account cannot take this action on that target (it is not its own), or needs attention.
404No such record for this account.
409No account is connected. Connect one with POST /v1/accounts/session, then retry.
422The connected account is signed out. Connect it again, then retry.
429Too many requests; retry after the window.
503This action is temporarily unavailable. Nothing was changed.

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

Done. Our neutral confirmation. The body is a PeopleWriteResult.

Fields of the 200 response
FieldTypeDescription
data requiredobjectOur neutral confirmation of the action taken.
Response headers
HeaderMeaning
RateLimit-LimitRequests this API key may make per minute.
RateLimit-RemainingRequests left in the current one-minute window.
RateLimit-ResetSeconds until the current window resets.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl
curl -X POST https://api.prospectapis.com/v1/people/endorse \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "person_ref": "person ref", "skill": "skill" }'
JavaScript (fetch)
const res = await fetch("https://api.prospectapis.com/v1/people/endorse", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "person_ref": "person ref",
    "skill": "skill"
  }),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);
Python (requests)
import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/people/endorse",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={
        "person_ref": "person ref",
        "skill": "skill",
    },
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.

Previous operation: Delete your comment. Next operation: Read a person's skills (live). Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).

Was this page helpful?