API reference / People writes

Edit your post

Written and maintained by The ProspectAPIs team

POST/v1/posts/edit

POST /v1/posts/edit is the ProspectAPIs operation editPost, in the People writes group of the REST API. Edit the text of one of your own posts. $0.02 per action. Give share_id or a post_url that names the post. 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

Request body

JSON. Give the text and one of post_id, share_id or post_url.

{
  "text": "text"
}

Responses

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.

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 -X POST https://api.prospectapis.com/v1/posts/edit \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "text" }'

const res = await fetch("https://api.prospectapis.com/v1/posts/edit", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "text": "text"
  }),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/posts/edit",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={
        "text": "text",
    },
    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.

Related

Previous operation: Finish an account's sign-in check. Next operation: Delete your post. 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).