Every Marketing API endpoint, grouped by what it works on. Organization- and event-level endpoints sit side by side, with the scope each one needs.
Waiting for your OK
| Endpoint | Level | Needs |
|---|
GET What is waiting for your OK/v1/organization/{orgId}/marketing/approvals | Organization | read:marketing |
How an event is doing
| Endpoint | Level | Needs |
|---|
GET How an event is doing (turnout and pacing)/v1/organization/{orgId}/marketing/goals/turnout | Organization | read:marketing |
POST Set an event's registration and attendance goal/v1/organization/{orgId}/marketing/goals/turnout/{eventId}/goal | Organization | write:marketing |
Webinar reporting
| Endpoint | Level | Needs |
|---|
GET Get the results report/v1/organization/{orgId}/marketing/results | Organization | read:marketing |
GET Webinar questions to follow up/v1/organization/{orgId}/marketing/results/questions | Organization | read:marketing |
GET Watch time by topic/v1/organization/{orgId}/marketing/results/topic-watch-time | Organization | read:marketing |
GET What happened after people attended/v1/organization/{orgId}/marketing/results/outcomes | Organization | read:marketing |
GET Outcomes window/v1/organization/{orgId}/marketing/results/outcomes/settings | Organization | read:marketing |
PUT Set the outcomes window/v1/organization/{orgId}/marketing/results/outcomes/settings | Organization | write:marketing |
Sign-ups
| Endpoint | Level | Needs |
|---|
GET List sign-up forms/v1/organization/{orgId}/marketing/audience/forms | Organization | read:marketing |
POST Create a sign-up form/v1/organization/{orgId}/marketing/audience/forms/create | Organization | write:marketing |
POST Add a sign-up form (no setup)/v1/organization/{orgId}/marketing/audience/forms/ensure | Organization | write:marketing |
GET Get a sign-up form/v1/organization/{orgId}/marketing/audience/forms/{formId} | Organization | read:marketing |
PUT Update a sign-up form/v1/organization/{orgId}/marketing/audience/forms/{formId} | Organization | write:marketing |
DELETE Archive a sign-up form/v1/organization/{orgId}/marketing/audience/forms/{formId} | Organization | write:marketing |
GET List sign-ups/v1/organization/{orgId}/marketing/audience/subscribers | Organization | read:marketing |
GET Export sign-ups (CSV)/v1/organization/{orgId}/marketing/audience/subscribers/export | Organization | read:marketing |
POST Add someone to a list/v1/organization/{orgId}/marketing/audience/subscribers/create | Organization | write:marketing |
POST Unsubscribe someone/v1/organization/{orgId}/marketing/audience/subscribers/unsubscribe | Organization | write:marketing |
GET How many people signed up/v1/organization/{orgId}/marketing/audience/summary | Organization | read:marketing |
Podcasts
| Endpoint | Level | Needs |
|---|
GET List podcasts/v1/organization/{orgId}/marketing/podcasts | Organization | read:marketing |
POST Create a podcast/v1/organization/{orgId}/marketing/podcasts/create | Organization | write:marketing |
GET Podcast suggestions/v1/organization/{orgId}/marketing/podcasts/suggestions | Organization | read:marketing |
POST Turn an event into a podcast/v1/organization/{orgId}/marketing/podcasts/from-event | Organization | write:marketing |
GET Podcast downloads/v1/organization/{orgId}/marketing/podcasts/stats | Organization | read:marketing |
GET Get a podcast/v1/organization/{orgId}/marketing/podcasts/{showId} | Organization | read:marketing |
PUT Update a podcast/v1/organization/{orgId}/marketing/podcasts/{showId} | Organization | write:marketing |
DELETE Archive a podcast/v1/organization/{orgId}/marketing/podcasts/{showId} | Organization | write:marketing |
GET Sessions that could be episodes/v1/organization/{orgId}/marketing/podcasts/{showId}/sessions | Organization | read:marketing |
POST Add episodes/v1/organization/{orgId}/marketing/podcasts/{showId}/episodes | Organization | write:marketing |
POST Approve or publish episodes/v1/organization/{orgId}/marketing/podcasts/{showId}/episodes/status | Organization | write:marketing |
PUT Update an episode/v1/organization/{orgId}/marketing/podcasts/{showId}/episodes/{episodeId} | Organization | write:marketing |
DELETE Remove an episode/v1/organization/{orgId}/marketing/podcasts/{showId}/episodes/{episodeId} | Organization | write:marketing |
Newsletter
| Endpoint | Level | Needs |
|---|
GET Get the newsletter/v1/organization/{orgId}/marketing/newsletter | Organization | read:marketing |
PUT Update the newsletter/v1/organization/{orgId}/marketing/newsletter | Organization | write:marketing |
POST Draft an issue/v1/organization/{orgId}/marketing/newsletter/issues/create | Organization | write:marketing |
GET Get an issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId} | Organization | read:marketing |
PUT Update an issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId} | Organization | write:marketing |
DELETE Delete a draft issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId} | Organization | write:marketing |
POST Send or schedule an issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId}/schedule | Organization | write:marketing |
POST Unschedule an issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId}/unschedule | Organization | write:marketing |
GET Issue results/v1/organization/{orgId}/marketing/newsletter/issues/{issueId}/results | Organization | read:marketing |
GET List an issue's kept versions/v1/organization/{orgId}/marketing/newsletter/issues/{issueId}/versions | Organization | read:marketing |
POST Restore a kept version of an issue/v1/organization/{orgId}/marketing/newsletter/issues/{issueId}/versions/{versionId}/restore | Organization | write:marketing |
Journeys
| Endpoint | Level | Needs |
|---|
GET List journeys/v1/organization/{orgId}/marketing/journeys | Organization | read:marketing |
PUT Update a journey/v1/organization/{orgId}/marketing/journeys/{journeyId} | Organization | write:marketing |
POST Reset a journey/v1/organization/{orgId}/marketing/journeys/{journeyId}/reset | Organization | write:marketing |
Video
| Endpoint | Level | Needs |
|---|
GET Recording playback/v1/organization/{orgId}/marketing/video/media/{mediaId}/playback | Organization | read:marketing |
GET Who watched a recording/v1/organization/{orgId}/marketing/video/media/{mediaId}/watchers | Organization | read:marketing |
GET A recording's gate, button and end card/v1/organization/{orgId}/marketing/video/items/{mediaId} | Organization | read:marketing |
PUT Change a recording's gate, button or end card/v1/organization/{orgId}/marketing/video/items/{mediaId} | Organization | write:marketing |
POST Ask for an email to watch a recording/v1/organization/{orgId}/marketing/video/items/{mediaId}/gate | Organization | write:marketing |
GET List premieres/v1/organization/{orgId}/marketing/video/premieres | Organization | read:marketing |
POST Schedule a premiere/v1/organization/{orgId}/marketing/video/premieres/ensure | Organization | write:marketing |
PUT Move, cancel or end a premiere/v1/organization/{orgId}/marketing/video/premieres/{premiereId} | Organization | write:marketing |
GET A premiere's questions and polls/v1/organization/{orgId}/marketing/video/premieres/{premiereId}/room | Organization | read:marketing |
POST Hide, show or answer a premiere question/v1/organization/{orgId}/marketing/video/premieres/{premiereId}/questions | Organization | write:marketing |
POST Add or change a premiere poll/v1/organization/{orgId}/marketing/video/premieres/{premiereId}/polls | Organization | write:marketing |
Website tag
| Endpoint | Level | Needs |
|---|
GET Website tag/v1/organization/{orgId}/marketing/audience/website | Organization | read:marketing |
GET Who visited/v1/organization/{orgId}/marketing/audience/website/visits | Organization | read:marketing |
GET A person's website activity/v1/organization/{orgId}/marketing/audience/people/{personKey}/website | Organization | read:marketing |
Consent
| Endpoint | Level | Needs |
|---|
GET A person's consent history/v1/organization/{orgId}/marketing/audience/people/{personKey}/consent | Organization | read:marketing |
| Endpoint | Level | Needs |
|---|
GET List sponsor links/v1/organization/{orgId}/marketing/audience/sponsor-shares | Organization | read:marketing |
POST Create a sponsor link/v1/organization/{orgId}/marketing/audience/sponsor-shares/create | Organization | write:marketing |
POST Revoke a sponsor link/v1/organization/{orgId}/marketing/audience/sponsor-shares/{shareId}/revoke | Organization | write:marketing |
Sites
| Endpoint | Level | Needs |
|---|
GET List Sites/v1/organization/{orgId}/sites | Organization | — |
POST Make a Site/v1/organization/{orgId}/sites/make | Organization | — |
GET Get a Site/v1/organization/{orgId}/sites/{siteId} | Organization | — |
PUT Edit a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft | Organization | — |
GET See what Publish would change/v1/organization/{orgId}/sites/{siteId}/diff | Organization | — |
GET Preview a Site as a role on a device/v1/organization/{orgId}/sites/{siteId}/preview | Organization | — |
POST Publish a Site/v1/organization/{orgId}/sites/{siteId}/publish | Organization | — |
POST Discard a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft/discard | Organization | — |
GET List a Site's versions/v1/organization/{orgId}/sites/{siteId}/versions | Organization | — |
POST Restore a version into the draft/v1/organization/{orgId}/sites/{siteId}/versions/{versionId}/restore | Organization | — |
