CRM Marketing REST-API
Synapcus CRM Marketing API
/qee/swagger-docs/synapcus_marketing.yaml
Introduction
The Synapcus REST API provides machine-readable access to the Synapcus-Cloud using an HTTP/HTTPS-based JSON REST interface. This page will show you how to get started, and how you can use the API to interact with your Synapcus system.
Some useful links:
Versioning and Changes
Qalgo GmbH will continuously expand the API's functionality. For best results, make sure your code can handle new JSON properties and does not depend on the order in which JSON objects are returned by the API, unless explicitly stated here.
Support
For any questions, please email us at info@qalgo.de - we are happy to help!
Authentication
For working with the Synapcus REST API you need an active account to a Synapcus system and the credentials for your user. You can then proceed to test the examples. Please also take a look at the general information which will give you an overview of how the API generally works.
Marketing
The Synapcus Marketing module deals with campaigns, marketing lists, contacts segmentation, serien emails and reactions monitoring as well as the generation of leads, which will be processed in the Synapcus CRM Sales module.
Servers
https://hska.synapcus.com/hska/synapcus.nsf - Synapcus HSKA Server
Authorize
cpg
All operations regarding a single campaign (cpg). The campaign entity represents a marketing project including the goal, responsibles, target group/-s, deadline, campagne response, budget informations.
Add a new marketing project (campaign).
Update an existing campaign
Finds and returns a campaign by unique ID
DELETE/xrCpg.xsp/rest/api
Deletes a specific campaign identified by unique ID
cpgs
Finds a collection of campaigns by fulltext query.
Finds a collection of campaigns by fulltext query.
DELETE/xrCpgs.xsp/rest/api
Deletes a collection of campaigns
percpg
Creates a new campaign participation.
Creates a new project participation.
Updates an existing campaign participation.
Finds and returns a campaign participation by unique ID
DELETE/xrPerCpg.xsp/rest/api
Deletes a specific campaign participation identified by unique ID
mkl
All operations regarding a single marketing list (target group) (mkl). Marketing list entity stores informations about a group of persons which are targeted through the customer segmentation / marketing process.
Creates a new marketing list (target group) (mkl)
Update an existing marketing list (target group) (mkl)
Returns a marketing list (target group) (mkl) by unique ID
DELETE/xrMkl.xsp/rest/api
Deletes a specific marketing list (target group) (mkl) identified by unique ID.
mkls
Finds a collection of marketing lists by fulltext query.
Finds a collection of marketing lists by fulltext query.
DELETE/xrMkls.xsp/rest/api
Deletes a collection of marketing lists
permkl
Creates a new marketing list participation.
Creates a new participation within the marketing list (target group).
Updates an existing marketing list participation.
Finds and returns a marketing list participation by unique ID
DELETE/xrPerMkl.xsp/rest/api
Deletes a specific marketing list participation identified by unique ID
sle
All operations regarding a single serial e-mail (sle).
Creates a new HTML serial letter / serial email (sle)
Updates an existing Synapcus serial (sle)
Returns an Synapcus serial (sle) by unique ID
DELETE/xrSle.xsp/rest/api
Deletes a single serial letter (sle) identified by unique ID
Schemas
JsonCollectionRequest
ApiResponse
JsonCollectionResponse