--- title: Merge API general usage description: What are the API urls and how to use them --- [Skip to content](https://support.postworks.co.uk/knowledge/sp-merge-general-usage#main-content) ![Logo (transparent background, red emblem, red text, tagline NOT included) (PRIVATE).png\]](https://support.postworks.co.uk/hs-fs/hubfs/Logo%20(transparent%20background%2c%20red%20emblem%2c%20red%20text%2c%20tagline%20NOT%20included)%20(PRIVATE).png?height=40&name=Logo%20(transparent%20background%2c%20red%20emblem%2c%20red%20text%2c%20tagline%20NOT%20included)%20(PRIVATE).png) Open main navigation Close main navigation - [Postworks Portal](https://app.postworks.co.uk/dashboard/send) [Postworks Portal](https://app.postworks.co.uk/dashboard/send) Hello. How can we help you? - There are no suggestions because the search field is empty. 1. [Support Centre](https://support.postworks.co.uk/knowledge?hsLang=en) 2. [Merge API](https://support.postworks.co.uk/knowledge/merge-api?hsLang=en) # Merge API general usage ## What are the API urls and how to use them In order to use the Merge API, you'll need an API Key, so please speak with support in order to be assigned one. The API Key should be added to every request as a header: X-API-KEY  your-assigned-key The Merge API will need first a template uploaded in order for a merge to be triggered. The main URL for the API is: [Staging URL](https://5ws6luf33e.execute-api.eu-west-1.amazonaws.com/staging/api) This is not the final URL and it will change. ### Templates `/api/Templates` - GET: gets all uploaded templates - Parameters: none - Returns: a list of all templates and ids - POST: Uploads a new template - Parameters: - body parameter named `Template` of type `File` - Returns:  the template id - DELETE: Deletes a template - Parameters: - query string ID of the template ### Merge `/api/Merge` - POST: Triggers a Merge using the specified Template and Data - Parameters:  - body parameter named `MergeData` of type `File` - this should point to the data file (XML, XLSX, etc) - body parameter named `MergeTemplateId` of type `Text` - this should be the ID of the template - Returns: Merge operation result - [Send Letters](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#main-content) - [Preparing your documents](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#preparing-your-documents) - [Sending via Web Portal](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#sending-via-web-portal) - [PDFs containing multiple recipients (mailmerges)](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#pdfs-containing-multiple-recipients-mailmerges) - [User Management](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#user-management) - [Reports](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#reports) - [Account Top-up](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#account-top-up) - [Quick Start Guide](https://support.postworks.co.uk/knowledge/send-letters?hsLang=en#quick-start-guide) - [Receive Letters](https://support.postworks.co.uk/knowledge/receive-letters?hsLang=en#main-content) - [Getting started](https://support.postworks.co.uk/knowledge/receive-letters?hsLang=en#getting-started) - [Viewing your post](https://support.postworks.co.uk/knowledge/receive-letters?hsLang=en#viewing-your-post) - [Managing inbound mail](https://support.postworks.co.uk/knowledge/receive-letters?hsLang=en#managing-inbound-mail) - [Digital Reply Envelopes (DREs)](https://support.postworks.co.uk/knowledge/receive-letters?hsLang=en#digital-reply-envelopes-dres) - [Account and Teams](https://support.postworks.co.uk/knowledge/account-and-teams?hsLang=en#main-content) - [User management](https://support.postworks.co.uk/knowledge/account-and-teams?hsLang=en#user-management) - [Permissions](https://support.postworks.co.uk/knowledge/account-and-teams?hsLang=en#permissions) - [Company settings](https://support.postworks.co.uk/knowledge/account-and-teams?hsLang=en#company-settings) - [Security and Compliance](https://support.postworks.co.uk/knowledge/account-and-teams?hsLang=en#security-and-compliance) - [Billing and payments](https://support.postworks.co.uk/knowledge/billing-and-payments?hsLang=en#main-content) - [Prepay account](https://support.postworks.co.uk/knowledge/billing-and-payments?hsLang=en#prepay-account) - [Troubleshooting](https://support.postworks.co.uk/knowledge/troubleshooting?hsLang=en#main-content) - [FAQ](https://support.postworks.co.uk/knowledge/troubleshooting?hsLang=en#faq) - [Troubleshooting](https://support.postworks.co.uk/knowledge/troubleshooting?hsLang=en#troubleshooting) - [Postworks API](https://support.postworks.co.uk/knowledge/postworks-api?hsLang=en#main-content) - [Getting started](https://support.postworks.co.uk/knowledge/postworks-api?hsLang=en#getting-started) - [API reference](https://support.postworks.co.uk/knowledge/postworks-api?hsLang=en#api-reference) - [Software Downloads](https://support.postworks.co.uk/knowledge/software-downloads?hsLang=en#main-content) - [PostboxPrint™](https://support.postworks.co.uk/knowledge/software-downloads?hsLang=en#postboxprint) - [PostboxServer™](https://support.postworks.co.uk/knowledge/software-downloads?hsLang=en#postboxserver) - ['Postworks friendly' documents](https://support.postworks.co.uk/knowledge/postworks-friendly-documents?hsLang=en#main-content) - [Standard letters](https://support.postworks.co.uk/knowledge/postworks-friendly-documents?hsLang=en#standard-letters) - [Mailmerge](https://support.postworks.co.uk/knowledge/postworks-friendly-documents?hsLang=en#mailmerge) - [Postworks Receive™](https://support.postworks.co.uk/knowledge/postworks-receive?hsLang=en#main-content) - [Pricing](https://support.postworks.co.uk/knowledge/postworks-receive?hsLang=en#pricing) - [PostboxServer™](https://support.postworks.co.uk/knowledge/postboxserver?hsLang=en#main-content) - [Getting started](https://support.postworks.co.uk/knowledge/postboxserver?hsLang=en#getting-started) - [PostboxPrint™](https://support.postworks.co.uk/knowledge/postboxprint?hsLang=en#main-content) - [Getting started](https://support.postworks.co.uk/knowledge/postboxprint?hsLang=en#getting-started) - [Using PostboxPrint™ with Antivirus software](https://support.postworks.co.uk/knowledge/postboxprint?hsLang=en#using-postboxprint-with-antivirus-software) - [Troubleshooting](https://support.postworks.co.uk/knowledge/postboxprint?hsLang=en#troubleshooting) - [Integrations](https://support.postworks.co.uk/knowledge/integrations?hsLang=en) - [Fastrack™](https://support.postworks.co.uk/knowledge/fastrack?hsLang=en#main-content) - [Getting Started](https://support.postworks.co.uk/knowledge/fastrack?hsLang=en#getting-started) - [Environmental](https://support.postworks.co.uk/knowledge/environmental?hsLang=en) - [ClearSend®](https://support.postworks.co.uk/knowledge/clearsend?hsLang=en) - [Merge API](https://support.postworks.co.uk/knowledge/merge-api?hsLang=en) - [Product updates](https://support.postworks.co.uk/knowledge/product-updates?hsLang=en) [![Chill listening crop-3](https://support.postworks.co.uk/hs-fs/hubfs/Logo%20(transparent%20background%2c%20red%20emblem%2c%20red%20text%2c%20tagline%20NOT%20included)%20(PRIVATE).png?width=109&height=24&name=Logo%20(transparent%20background%2c%20red%20emblem%2c%20red%20text%2c%20tagline%20NOT%20included)%20(PRIVATE).png "Chill listening crop-3")](https://www.postworks.co.uk) Our mission is to 'be a pleasure to do business with'. Thank you for choosing us. Copyright © 2025, Postworks Limited