Get started
Connect to Prezly, find a newsroom, and read your first story.
Use the Prezly API to connect your tools to your PR work or build a website around your stories. Start with a read request: you can check your access and explore your data without changing anything.
Choose your starting point
- Connect your tools. Choose your credentials, then make your first API request.
- Build a custom newsroom. Follow the story rendering guide, or start from the Bea theme.
- Connect an AI assistant. Follow the MCP setup guide. MCP uses a personal API token.
Understand the data you will read
Your Prezly account gives you access to one or more sites, called newsrooms in the API. A newsroom contains stories. Each story belongs to a newsroom and represents content in a particular language.
The API returns a uuid for each newsroom and story. Use those UUIDs in your requests. Some responses also contain a numeric id; you will still see these in older integrations.
Your credentials determine which account and newsrooms you can access. A successful request does not mean you can see every newsroom in the organization.
Read your first story
- Set up authentication. Choose a personal token for a local script, or an integration key for an ongoing service.
- Make your first request. List your newsrooms, find a story, and retrieve it.
- Open the reference when you need the complete parameters and response fields: List Newsrooms, List Stories, or Get Story.
The REST API base URL is https://api.prezly.com/v2. The walkthrough uses cURL and includes a JavaScript example using fetch. You can also use the JavaScript SDK, @prezly/sdk, when building an integration.
Build beyond the first request
- Resources and identifiers: understand sites, stories, UUIDs, and related records.
- Pagination and sorting: retrieve a complete list in a deliberate order.
- Filtering results: select the stories your integration needs.
- Handling errors: inspect failures and decide what to retry.
Build a newsroom around your stories
Start with Content formats and Story rendering, then adapt rich content and images and files to your layout. Use the JavaScript SDK for typed API calls.
Add press-contact cards, manage newsroom galleries, and build subscription and preference flows around that reading experience.
Author and migrate stories
-
Newsrooms, languages, and categories: inspect the destination before authoring or publishing.
-
Creating and updating stories: create a private draft and replace content with a version check.
-
Importing HTML: preview conversion, save content, and re-import into a known story.
-
Story translations: link existing language versions or start a translation copy.
-
Publishing stories: review a draft, publish or schedule it, and understand unpublishing.
Work with contacts and outreach
- Working with contacts: find CRM records, create people/organisations, and update selected fields.
- Campaign audiences: choose sources, inspect actual addresses, and handle deferred additions.
- Email campaigns: prepare, test, send, and schedule a reviewed message.
- Individual pitches: write to a known contact and reconcile the sending state.
Use Manage email senders for sending identities and Manage reusable snippets for shared content. After outreach, Track media coverage explains recording and maintaining clippings.
Connect an AI assistant
Start with the Prezly MCP overview, then set up a client and verify a read. Review the tool workflows and token restrictions, safety and privacy, and troubleshooting before enabling changes.
Configure the newsroom itself
Follow Create and configure a newsroom for initial setup and hosted availability. Maintain categories and languages, then review custom domains and themes before changing the public site.
Keep integrations in sync
Use Webhooks to react to story and category changes. For a custom visitor form, Handle privacy requests explains recording, verifying, and confirming a request. Both workflows require an integration API key; personal tokens are unsupported.