PingRepDocs

Content

Posts API

Create, edit, and publish long-form content through the PingRep Posts API.

Posts API

Posts are long-form content tied to your professional profile. Use them for thought leadership, case studies, or portfolio pieces. Posts support Markdown, tags, cover images, and AI-suggested questions that visitors can ask your AI Representative.

Authentication required

All post management endpoints require a valid JWT or API key.

Create a post

POST
/api/v1/posts
API Key

Create a new post draft.

Request body

titlestringRequired

Post title. Displayed as the heading and used in the URL slug.

slugstringRequired

URL-safe identifier for the post. Must be unique per user.

bodyMarkdownstringRequired

Post content in Markdown format.

tagsstring[]Optional

Array of topic tags for categorization and discovery.

coverImageUrlstringOptional

URL to the cover image displayed at the top of the post.

suggestedQuestionsstring[]Optional

Questions visitors can click to ask your AI Representative about this post.

statusstringOptional

Initial status: 'draft' (default) or 'published'.

List your posts

GET
/api/v1/posts
API Key

List all posts belonging to the authenticated user, including drafts and published.

Returns posts ordered by creation date (newest first). Use this to build a content dashboard or editorial calendar.

Get a post by ID

GET
/api/v1/posts/{post_id}
API Key

Retrieve a specific post by its unique ID.

Update a post

PATCH
/api/v1/posts/{post_id}
API Key

Update one or more fields on an existing post.

Send only the fields you want to change. Updating a published post takes effect immediately.

Delete a post

DELETE
/api/v1/posts/{post_id}
API Key

Permanently delete a post. This action cannot be undone.

Deleting a published post immediately removes it from your public profile. Any shared links or short URLs will return a 404.

Publish a post

POST
/api/v1/posts/{post_id}/publish
API Key

Publish a draft post, making it visible on your public profile.

Unpublish a post

POST
/api/v1/posts/{post_id}/unpublish
API Key

Revert a published post to draft status.

Unpublished posts are removed from your public profile but not deleted. You can republish at any time.

Suggested questions

Add 2-3 suggested questions to each post. These appear as quick-tap buttons when visitors interact with your AI Representative, driving engagement with your content.