Get Frequency Cap

GET

api

frequency-cap

Get Frequency Cap

curl --request GET \
  --url https://api.sequenzy.com/api/v1/frequency-cap \
  --header 'Authorization: Bearer <token>'

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/frequency-cap",
  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;
}

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/frequency-cap"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/frequency-cap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "frequencyCap": {
    "maxEmails": 1,
    "windowHours": 16
  }
}

{
  "success": true,
  "frequencyCap": null
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: account:read"
}

Get your company frequency cap: the most marketing emails one contact may receive in a rolling window, such as 1 email every 16 hours. Only sequences with frequencyCapEnabled respect the cap. When one of their email steps comes up for a contact who already received the cap’s number of marketing emails in the window, the step is skipped and the contact moves on to the next step. Campaign emails and marketing sequence emails count toward the cap, including earlier emails from the same sequence. Campaigns always send. Transactional emails never count, and transactional steps are never skipped. Requires the account:read scope.

Request

curl "https://api.sequenzy.com/api/v1/frequency-cap" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

object | null

The company cap, or null when none is set.

integer

Most marketing emails one contact may receive in the window, from 1 to 50.

integer

Rolling window in hours, from 1 to 168.

{
  "success": true,
  "frequencyCap": {
    "maxEmails": 1,
    "windowHours": 16
  }
}

{
  "success": true,
  "frequencyCap": null
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: account:read"
}

Get Frequency Cap

curl --request GET \
  --url https://api.sequenzy.com/api/v1/frequency-cap \
  --header 'Authorization: Bearer <token>'

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/frequency-cap",
  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;
}

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/frequency-cap"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/frequency-cap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "frequencyCap": {
    "maxEmails": 1,
    "windowHours": 16
  }
}

{
  "success": true,
  "frequencyCap": null
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: account:read"
}

​Request

​Response fields

Request

Response fields