Sequenzy Frequency Cap API
The Frequency Cap API from Sequenzy — 1 operation(s) for frequency cap.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sequenzy:sequenzy-frequency-cap-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Sequenzy Frequency Cap API
description: Sequenzy API for managing subscribers, tags, events, sequences, and transactional emails
version: 1.0.0
servers:
- url: https://api.sequenzy.com/api/v1
description: Production server
- url: https://api.sequenzy.com/v1
description: Legacy production server alias
security:
- bearerAuth: []
tags:
- name: Frequency Cap
paths:
/frequency-cap:
get:
operationId: getFrequencyCap
summary: Get frequency cap
description: Returns the company frequency cap, or null when none is set. Only sequences with frequencyCapEnabled respect it; their email steps are skipped for a contact already at the cap. Campaigns count toward the cap but always send. Transactional emails never count. Requires the account:read scope.
tags:
- Frequency Cap
responses:
'200':
description: Frequency cap returned
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
frequencyCap:
oneOf:
- $ref: '#/components/schemas/FrequencyCap'
- type: 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: API key is missing the account:read scope
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Company not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
put:
operationId: setFrequencyCap
summary: Set frequency cap
description: Sets or replaces the company frequency cap. It applies from the next email step onward in sequences with frequencyCapEnabled. Requires the companies:manage scope plus owner or admin access.
tags:
- Frequency Cap
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FrequencyCap'
responses:
'200':
description: Frequency cap saved
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
frequencyCap:
$ref: '#/components/schemas/FrequencyCap'
'400':
description: maxEmails or windowHours is missing, not an integer, or out of range
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing the companies:manage scope, or view-only access
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Company not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: clearFrequencyCap
summary: Clear frequency cap
description: Turns the company frequency cap off. Sequences keep their frequencyCapEnabled setting, but nothing is skipped until a cap is set again. Requires the companies:manage scope plus owner or admin access.
tags:
- Frequency Cap
responses:
'200':
description: Frequency cap cleared
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
frequencyCap:
type: 'null'
description: Always null after clearing.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing the companies:manage scope, or view-only access
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Company not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
headers:
RetryAfter:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
minimum: 1
example: 1
responses:
TransientDatabaseUnavailable:
description: The database was temporarily unavailable. The request may be retried after the delay in Retry-After.
headers:
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
error: The service could not reach its database for a moment. Retry the request.
code: SERVICE_UNAVAILABLE
schemas:
FrequencyCap:
type: object
description: At most maxEmails marketing emails (campaigns plus marketing sequence emails) per contact in any rolling windowHours.
required:
- maxEmails
- windowHours
properties:
maxEmails:
type: integer
minimum: 1
maximum: 50
description: Most marketing emails one contact may receive in the window.
example: 1
windowHours:
type: integer
minimum: 1
maximum: 168
description: Rolling window in hours.
example: 16
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
code:
type: string
description: Optional stable machine-readable error discriminator when available.
example: COMPANY_CREATE_REQUIRES_PERSONAL_KEY
retryable:
type: boolean
description: Whether retrying the request can recover from the error.
issues:
type: array
description: Field-level problems with the request, when the endpoint reports them. Up to ten entries; `error` summarizes the first three.
items:
$ref: '#/components/schemas/InputIssue'
required:
- error
InputIssue:
type: object
properties:
path:
type: string
description: Dotted field path, such as `audience.subscriberIds[0]`. Empty when the problem is with the request body itself.
example: kind
message:
type: string
description: What is wrong with the field.
example: must be "add_tags"
allowedValues:
type: array
description: Accepted values when the field only takes a fixed set of values.
items: {}
example:
- add_tags
required:
- path
- message
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key passed as Bearer token