The shared suppression list with reasons, sources and provider sync

GET

/api/v1/workspaces/{workspace}/suppressions

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/suppressions?reason=hard_bounce&since=7d&appliesTo=all&page=1&pageSize=10"

  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(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/suppressions?reason=hard_bounce&since=7d&appliesTo=all&page=1&pageSize=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/suppressions?reason=hard_bounce&since=7d&appliesTo=all&page=1&pageSize=10' \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Query Parameters

Address or domain

string

<= 200 characters

Address or domain

reason

string

Allowed values: hard_bounce complaint unsubscribe manual invalid spam_trap ""

source

string

<= 60 characters

since

string

Allowed values: 7d 30d ""

import

Show the rows of one import group

string

Show the rows of one import group

appliesTo

All: every stream; marketing: Broadcasts and Automations only (unsubscribes, role addresses)

string

Allowed values: all marketing ""

All: every stream; marketing: Broadcasts and Automations only (unsubscribes, role addresses)

page

integer format: int64

default: 1 >= 1

pageSize

integer format: int64

default: 10 >= 1 <= 100

Responses

200

application/json

object

counts

required

object

complaint

required

integer format: int64

hardBounce

required

integer format: int64

manual

required

integer format: int64

other

required

integer format: int64

total

required

integer format: int64

unsubscribe

required

integer format: int64

items

required

Array<object>

object

address

required

string

required

string format: date-time

campaignId

string

context

required

string

group

required

boolean

required

string

importId

string

originalCode

required

string

reasons

required

Array<string>

rows

required

integer format: int64

scope

required

string

Allowed values: all marketing

source

required

object

adapter

string

kind

required

string

label

required

Amazon SES, Preference center, Linh Nguyen, Brevo import…

string

matching

required

Addresses matching the filter

integer format: int64

page

required

integer format: int64

pageSize

required

integer format: int64

sources

required

Array<object>

object

label

required

string

value

required

string

sync

required

Array<object>

object

adapter

required

string

string format: date-time

detail

required

string

local

required

boolean

name

required

string

providerId

required

string

pulled

required

integer format: int64

pulledNote

required

string

pushed

required

integer format: int64

status

required

string

Allowed values: in_sync syncing error off

total

required

Rows matching, groups counted once

integer format: int64

Example

{
  "items": [
    {
      "scope": "all"
    }
  ],
  "sync": [
    {
      "status": "in_sync"
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}