Products

Create a product

Create a product using a normal API key. Products start private and unclaimed. Open the returned claim link to sign in and claim the product, then confirm its details in the normal editor and choose a plan. Claiming requires account authentication and does not publish the product or make a purchase. Keep the link private. Returns 201 Created with a Location header pointing to /api/v1/products/{id}/status.

post/api/v1/products

Request

  • Base URL: https://peerpush.com
  • URL: https://peerpush.com/api/v1/products
  • Auth: one of:
    • API key in header X-PeerPush-Api-Key
    • API key in query parameter api_key

Headers

Idempotency-Keystring

Optional, scoped to the API key. Supply it on the original request and reuse it with the same payload for safe retries; a different payload conflicts. Without it, each successful request creates a new product.

Request body

namestring required
taglinestring required
descriptionstring required
websiteUrlstring uri required
appStoreUrlstring nullable
playStoreUrlstring nullable
mcpServerUrlstring nullable
cliInstallCommandstring nullable
apiDocsUrlstring nullable
mrrnumber nullable
twitterUsernamestring nullable
linkedinUrlstring nullable
categoriesstring[]
useCasesstring[]
audiencesstring[]
pricingType'Free' | 'Freemium' | 'Subscription' | 'OneTime' | 'Paid' nullable
startingPricenumber nullable
platformsstring[]
logoUrlstring uri required
screenshotUrlsstring[]
externalIdstring
contactEmailstring email required

Contact address for the person who should claim this product. Required. Never published or returned by the API, and only PeerPush staff can see it. PeerPush emails it once, to remind the owner to claim the product before the link expires.

Response

Create a product

Changes

No recorded changes to this operation across all 1 revision of this API.