List marketing campaigns

curl --request GET \
  --url https://api.mercemur.com/api/v1/marketing-campaigns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/marketing-campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "channel": "<string>",
      "completed_at": null,
      "created_at": "<string>",
      "enqueued_count": 123,
      "id": "<string>",
      "name": "<string>",
      "scheduled_for": null,
      "segment_id": "<string>",
      "started_at": null,
      "status": "<string>",
      "subject": "<string>",
      "template_id": null,
      "updated_at": "<string>"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

API Reference

List marketing campaigns

The store’s marketing campaigns, newest first. IT DOES NOT CARRY THE CAMPAIGN BODY, and that is a size bound rather than a permission one: a body may be 500 KB and a page may hold 100 rows, so a list that served them could answer one request with fifty megabytes of markup. Read a single campaign to get its copy. ?status= and ?channel= narrow it, so “what is sending right now” is one call. An unknown value for either is a 400 rather than the unfiltered list, because “no paused campaign” and “there is no such status” are different facts and a client told the first stops looking. enqueued_count IS NOT DELIVERY. It counts the messages a campaign handed to the sending spine; the spine’s own compliance gate can still decline an individual recipient, and the stats route is where that shows up.

GET

api

marketing-campaigns

curl --request GET \
  --url https://api.mercemur.com/api/v1/marketing-campaigns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/marketing-campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "channel": "<string>",
      "completed_at": null,
      "created_at": "<string>",
      "enqueued_count": 123,
      "id": "<string>",
      "name": "<string>",
      "scheduled_for": null,
      "segment_id": "<string>",
      "started_at": null,
      "status": "<string>",
      "subject": "<string>",
      "template_id": null,
      "updated_at": "<string>"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

status

enum<string>

Filter by lifecycle state. sending and paused are the two a monitoring client polls; sent and cancelled are terminal, so a campaign in either will not move again. A value outside the enum is a 400 naming the legal set.

Available options:

draft,

scheduled,

sending,

paused,

sent,

cancelled

channel

enum<string>

Filter by transport. A value outside the enum is a 400 rather than an empty page, which would read as "this store sends no email".

Available options:

email,

sms,

push

limit

integer

default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100

after

string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data

object[]

Show child attributes

page

object

Show child attributes

Overview

Endpoints

List marketing campaigns

Authorizations

Query Parameters

Response