REST API v3

The REST API allows you to retrieve and update the data that is stored inside Copernica from out of your own website or app. You can write your own scripts that send requests and instructions to our servers to fetch this data or to update it. You can use this API to automatically synchronize the data in Copernica with your own system, without any human interference. This page contains an overview of all API calls.

• Introduction & registration
• Sending and receiving HTTP requests
• External OAuth2 links
• Paging

We are currently on version 3 of the REST API. This article explains the new version (and how to switch) in full detail. Not ready to switch? If you want to use previous versions of the API, here is a link to the v1 and v2 documentation.

Method types

There are four types of methods:

• GET: Used to fetch data
• POST: Used to create new data
• PUT: Used to overwrite existing data
• DELETE: Used to delete data

See the introduction for more information about HTTP requests.

Overview

Use the links below to jump to the type of API call you are looking for.

• Account
• Databases & Collections
• Views & Miniviews
• Rules & Minirules
• Profiles & Subprofiles
• Publisher Mailings
• Marketing Suite Mailings
• Datarequests
• Logfiles
• Sender domains

Account

In the table below you can find a call to retrieve account information.

Databases & Collections

You can search and maintain your databases and collections with API calls. The following table contains the calls related to database and collection structure.

Databases

Collections

Import

Views & Miniviews

Views are selections under a database, while miniviews are selections under a collection. You can find methods that relate to a specific (mini)view below.

View

Miniview

Rules & Minirules

Rules and minirules are made up of several conditions to create selections under a database or collection respectively. You can find API calls related to rules and their conditions in the table below.

Rules

Minirules (for miniselections)

Profiles & Subprofiles

Profiles and subprofiles can be used to represent entities in your database, like your customers or orders. The relevant API calls can be found below.

Profile

Subprofile

Publisher Mailings

The table below contains all API calls related to Publisher documents, templates and mailings.

Mailings

Documents & Templates

Destinations

Statistics

Marketing Suite Mailings

The table below contains all API calls related to Marketing Suite templates and emailings.

Mailings

Templates

Messages & Destinations

Copernica uses the terms messages and destinations interchangeably in the Marketing Suite. Both refer to a specific message sent to a specific profile or subprofile. Please keep in mind that you can substitute 'message' by 'destination' or vice versa in all of the articles below, including the code examples.

Statistics

SMS mailings

Coupons

Media libraries

Datarequests

The result of data requests is stored for a while after completion. With the following methods you can retrieve the status and data of previously completed calls.

Logfiles

Copernica keeps extensive logfiles about everything that happens to your emails after sending. You can find all calls related to logfiles in the table below.

Webhooks

Webhooks are processes that notify their user of events that happen in real time through HTTP POST. You can find all calls related to webhooks in the table below.

Sender domains

Within our software you can configure from which domain or subdomain do you to send your emails. If you want the 'FROM' address of your emails to be info@example.com, you need to provide 'example.com' as your sender domain.