Sequenzy Audience Syncs API
The Audience Syncs API from Sequenzy — 4 operation(s) for audience syncs.
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-audience-syncs-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 Audience Syncs 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: Audience Syncs
paths:
/audience-syncs:
get:
summary: List audience syncs
description: Lists segment-to-Meta-audience syncs with schedule and last sync status.
operationId: listAudienceSyncs
tags:
- Audience Syncs
responses:
'200':
description: Audience syncs returned
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
audienceSyncs:
type: array
items:
$ref: '#/components/schemas/AudienceSync'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
post:
summary: Create audience sync
description: Pushes a segment to a Meta custom audience and keeps it synced on a schedule. Provide segmentId for an existing segment or predefinedSegmentId for a ready-made template (for example zero-ltv, no-purchase-1y, recent-buyers); template segments are created automatically on first use. The first upload runs immediately. Audiences are add-only - subscribers who later leave the segment stay in the Meta audience. Requires the Meta Ads integration to be connected in the dashboard.
operationId: createAudienceSync
tags:
- Audience Syncs
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
segmentId:
type: string
description: Existing segment ID. Provide either segmentId or predefinedSegmentId, not both.
predefinedSegmentId:
type: string
description: Ready-made segment template ID (for example recent-buyers). The template segment is created on first use and reused afterwards; an unrelated same-named segment with different filters causes a 409.
adAccountId:
type: string
description: Meta ad account ID (act_...). See GET /ad-accounts.
audienceName:
type: string
description: Name for the custom audience in Meta Ads Manager.
frequency:
type: string
enum:
- hourly
- daily
- weekly
default: daily
required:
- adAccountId
- audienceName
anyOf:
- required:
- segmentId
- required:
- predefinedSegmentId
responses:
'200':
description: Audience sync created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
audienceSync:
$ref: '#/components/schemas/AudienceSync'
'400':
description: Validation error (for example both segmentId and predefinedSegmentId provided) or Meta Ads not connected
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Segment not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Segment already synced to that ad account, or the template's name is taken by an unrelated segment with different filters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/audience-syncs/{syncId}:
patch:
summary: Update audience sync
description: Changes an audience sync's frequency or pauses/resumes it.
operationId: updateAudienceSync
tags:
- Audience Syncs
parameters:
- name: syncId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
frequency:
type: string
enum:
- hourly
- daily
- weekly
isActive:
type: boolean
description: false pauses the sync, true resumes it.
responses:
'200':
description: Audience sync updated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
audienceSync:
$ref: '#/components/schemas/AudienceSync'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Audience sync not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Delete audience sync
description: Removes the sync mapping. The Meta audience itself is kept so running ads are not disrupted - only future syncs stop.
operationId: deleteAudienceSync
tags:
- Audience Syncs
parameters:
- name: syncId
in: path
required: true
schema:
type: string
responses:
'200':
description: Audience sync deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Audience sync not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
/audience-syncs/{syncId}/sync:
post:
summary: Run audience sync now
description: Triggers an immediate upload outside the regular schedule. The sync must be active.
operationId: runAudienceSyncNow
tags:
- Audience Syncs
parameters:
- name: syncId
in: path
required: true
schema:
type: string
responses:
'200':
description: Sync queued
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
queued:
type: boolean
example: true
'400':
description: Sync is paused
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Audience sync not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/ad-accounts:
get:
summary: List ad accounts
description: Lists the Meta ad accounts reachable through the connected Meta Ads integration.
operationId: listAdAccounts
tags:
- Audience Syncs
responses:
'200':
description: Ad accounts returned
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
adAccounts:
type: array
items:
$ref: '#/components/schemas/AdAccount'
'400':
description: Meta Ads not connected
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
components:
headers:
RetryAfter:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
minimum: 1
example: 1
schemas:
AudienceSync:
type: object
description: A segment-to-Meta-custom-audience sync mapping.
properties:
id:
type: string
example: sync_abc123
segmentId:
type: string
example: seg_recent_buyers
segmentName:
type:
- string
- 'null'
example: Recent buyers
adAccountId:
type: string
example: act_1234567890
audienceName:
type: string
example: Sequenzy - Recent buyers
frequency:
type: string
enum:
- hourly
- daily
- weekly
isActive:
type: boolean
syncStatus:
type: string
description: idle, syncing, error, or disconnected (the Meta connection was revoked; the sync is paused until you reconnect)
example: idle
lastSyncAt:
type:
- string
- 'null'
format: date-time
lastSyncError:
type:
- string
- 'null'
lastSyncedCount:
type: integer
description: Subscribers uploaded in the most recent run.
createdAt:
type: string
format: date-time
AdAccount:
type: object
properties:
id:
type: string
example: act_1234567890
name:
type: string
example: Acme Main Account
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
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
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key passed as Bearer token