For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Login Start trial Get a demo

Welcome
Webhooks
OAuth2
API Reference

Getting Started
Create an API Key
Pagination
Rate Limiting
No-Code Integrations
Webhooks
Newsletter List Subscription Subscribed
Newsletter List Subscription Unsubscribed
Newsletter List Subscription Paused
Newsletter List Subscription Resumed
Post Sent
Post Updated
Post Scheduled
Subscription Created
Subscription Confirmed
Subscription Deleted
Subscription Upgraded
Subscription Downgraded
Subscription Paused
Subscription Resumed
Subscription Tier Paused
Subscription Tier Resumed
Subscription Tier Added
Subscription Tier Deleted
Survey Response Submitted
OAuth2
Authorize
Create token
Revoke token
Introspect token
Get token info
Get advertisement opportunities <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
List authors
Get author
Add subscription to an automation <Badge intent="info" minimal outlined>OAuth Scope: automations:write</Badge>
List automation journeys <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>
Get automation journey <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>
List automations <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>
Get automation <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>
List automation emails
Bulk create subscription <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
List subscription updates <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:read</Badge>
Get subscription update <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:read</Badge>
Update subscriptions <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Update subscriptions <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Update subscriptions' status <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Update subscriptions' status <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
List complimentary access <Badge intent="info" minimal outlined>OAuth Scope: complimentary_access:read</Badge>
Get complimentary access <Badge intent="info" minimal outlined>OAuth Scope: complimentary_access:read</Badge>
List condition sets <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>
Get condition set <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>
Create custom field <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:write</Badge>
Get custom field <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:read</Badge>
List custom fields <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:read</Badge>
Update custom field <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:write</Badge>
Update custom field <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:write</Badge>
Delete custom field <Badge intent="info" minimal outlined>OAuth Scope: custom_fields:write</Badge>
Create data deletion request <Badge intent="info" minimal outlined>OAuth Scope: data_deletion:write</Badge>
Get data deletion request <Badge intent="info" minimal outlined>OAuth Scope: data_deletion:read</Badge>
List data deletion requests <Badge intent="info" minimal outlined>OAuth Scope: data_deletion:read</Badge>
Get publication engagements <Badge intent="info" minimal outlined>OAuth Scope: publications:read</Badge>
List newsletter lists <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:read</Badge>
Get newsletter list <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:read</Badge>
Create newsletter list <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
Update newsletter list <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
Delete newsletter list <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
Create newsletter list subscription <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
List newsletter list subscriptions <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:read</Badge>
Get newsletter list subscription <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:read</Badge>
Update newsletter list subscription <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
Update newsletter list subscription by subscription ID <Badge intent="info" minimal outlined>OAuth Scope: newsletter_lists:write</Badge>
Identify user <Badge intent="info" minimal outlined>OAuth Scope: identify:read</Badge>
List polls <Badge intent="info" minimal outlined>OAuth Scope: polls:read</Badge>
Get poll <Badge intent="info" minimal outlined>OAuth Scope: polls:read</Badge>
List poll responses <Badge intent="info" minimal outlined>OAuth Scope: polls:read</Badge>
Create post <Badge intent="info" minimal outlined>OAuth Scope: posts:write</Badge>
Update post <Badge intent="info" minimal outlined>OAuth Scope: posts:write</Badge>
List posts <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
Get aggregate stats <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
Get post <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
Delete post <Badge intent="info" minimal outlined>OAuth Scope: posts:write</Badge>
Send test email <Badge intent="info" minimal outlined>OAuth Scope: posts</Badge>
Generate post preview URL <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
Get post templates <Badge intent="info" minimal outlined>OAuth Scope: posts:read</Badge>
List publications <Badge intent="info" minimal outlined>OAuth Scope: publications:read</Badge>
Get publication <Badge intent="info" minimal outlined>OAuth Scope: publications:read</Badge>
Get referral program <Badge intent="info" minimal outlined>OAuth Scope: referral_program:read</Badge>
Create segment
List segments <Badge intent="info" minimal outlined>OAuth Scope: segments:read</Badge>
Get segment <Badge intent="info" minimal outlined>OAuth Scope: segments:read</Badge>
Recalculate segment <Badge intent="info" minimal outlined>OAuth Scope: segments:write</Badge>
List segment subscribers <Badge intent="info" minimal outlined>OAuth Scope: segments:read</Badge>
List segment subscriber IDs <Badge intent="info" minimal outlined>OAuth Scope: segments:read</Badge>
Delete segment <Badge intent="info" minimal outlined>OAuth Scope: segments:write</Badge>
Create subscription <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
List subscriptions <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:read</Badge>
Get subscription by email <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:read</Badge>
Get subscription by ID <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:read</Badge>
Update subscription by ID <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Update subscription by ID <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Update subscription by email <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Delete subscription <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Add subscription tag <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>
Create a tier <Badge intent="info" minimal outlined>OAuth Scope: tiers:write</Badge>
List tiers <Badge intent="info" minimal outlined>OAuth Scope: tiers:read</Badge>
Get tier <Badge intent="info" minimal outlined>OAuth Scope: tiers:read</Badge>
Update a tier <Badge intent="info" minimal outlined>OAuth Scope: tiers:write</Badge>
Update a tier <Badge intent="info" minimal outlined>OAuth Scope: tiers:write</Badge>
Create a webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>
List webhooks <Badge intent="info" minimal outlined>OAuth Scope: webhooks:read</Badge>
Get webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:read</Badge>
Update webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>
Delete a webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>
Identify workspace <Badge intent="info" minimal outlined>OAuth Scope: identify:read</Badge>
Get publications by subscription email <Badge intent="info" minimal outlined>OAuth Scope: publications:read</Badge>

Login Start trial Get a demo

Webhooks Newsletter List Subscription

Newsletter List Subscription Paused

Payload

1 {
2   "data": {
3     "id": "nl_list_sub_00000000-0000-0000-0000-000000000000",
4     "list_name": "Weekly Digest",
5     "subscription_id": "sub_00000000-0000-0000-0000-000000000000",
6     "email": "[email protected]",
7     "status": "active",
8     "created": 1666800076,
9     "updated": 1666800076,
10     "subscribed_at": 1666800076
11   },
12   "event_timestamp": 1666800076,
13   "event_type": "newsletter_list_subscription.paused",
14   "uid": "evt_00000000-0000-0000-0000-000000000000"
15 }

Payload

The payload of this webhook request is an object.

dataobjectOptional

event_timestampintegerOptional

The date the event was created. Measured in seconds since the Unix epoch.

event_typestringOptional

The event type.

uidstringOptional

The prefixed event ID, unique to each webhook event.

Response

200

any

Return a 200 status to indicate that the data was received successfully.

Was this page helpful?

Payload

The payload of this webhook request is an object.

dataobjectOptional

event_timestampintegerOptional

The date the event was created. Measured in seconds since the Unix epoch.

event_typestringOptional

The event type.

uidstringOptional

The prefixed event ID, unique to each webhook event.

Response

200

any

Return a 200 status to indicate that the data was received successfully.