Do not miss any REST API changes, ever again

Subscribe to the REST API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
2 structure changes including:
2 Additions
Added 2
GET /newsletters/{newsletter}/rooms
GET /rooms/{room}
77 structure changes including:
1 Addition
76 Modifications
Modified 76 Breaking
POST thread.createdwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • audience_scoped property Added
POST /articles/{article}/schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
PATCH /website-pages/{page}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
PATCH /tags/{tag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • is_room property Added
PATCH /subscribers/{subscriber}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • tags property Modified
        • property Modified
PATCH /domains/{domain}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
PATCH /automations/{automation}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
PATCH /articles/{article}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
GET /website-pages/{page}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /threads/{thread}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • thread, newsletter, highlight properties Modified
GET /threads/{thread}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • audience_scoped, audience_tag_ids properties Added
GET /tags/{tag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • is_room property Added
GET /subscribers/{subscriber}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • tags property Modified
        • property Modified
GET /sends/{send}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • article property Modified
        • Article alternative Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /senders/{sender}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • resource property Modified
GET /runs/{run}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • automation property Modified
        • AutomationSummary alternative Modified
GET /newsletters/{newsletter}/website-pages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/timeseries
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /newsletters/{newsletter}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • featured_article property Modified
        • Article alternative Modified
POST /website-pages/{page}/unpublish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /website-pages/{page}/publish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /threads/{thread}/publish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • audience_scoped, audience_tag_ids properties Added
POST /threads/{thread}/messages
  • Response
  • 201 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • highlight property Modified
        • Highlight alternative Modified
POST /tags/{tag}/subscribers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tag property Modified
        • newsletter property Modified
        • is_room property Added
POST /subscribers/{subscriber}/tags/{tag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • is_room property Added
POST /publishable-keys/{publishable_key}/rotate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /newsletters/{newsletter}/website-pages
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /newsletters/{newsletter}/website-assets
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /newsletters/{newsletter}/threads
  • Body
  • application/json content type Modified
    • property Modified
      • ThreadCreateRequest property Modified
        • content property Modified
          • Property is now required
            Breaking
        • media property Modified
          • Property is no longer required
        • audience_tag_ids property Added
      • ThreadCreateRequest property Modified
        • audience_tag_ids property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • audience_scoped, audience_tag_ids properties Added
POST /newsletters/{newsletter}/tags
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • is_room property Added
POST /newsletters/{newsletter}/subscribers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • tags property Modified
        • property Modified
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • tags property Modified
        • property Modified
POST /newsletters/{newsletter}/publishable-keys
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /newsletters/{newsletter}/automations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /newsletters/{newsletter}/articles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
POST /automations/{automation}/pause
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /automations/{automation}/activate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
POST /articles/{article}/unschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
POST /articles/{article}/send
  • Response
  • 202 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
GET /newsletters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • featured_article property Modified
GET /messages/{message}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • highlight property Modified
        • Highlight alternative Modified
GET /highlights/{highlight}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • article property Modified
        • Article alternative Modified
GET /domains/{domain}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /delivery-attempts/{attempt}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /automations/{automation}/runs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • automation property Modified
GET /automations/{automation}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /articles/{article}/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • article property Modified
        • Article alternative Modified
GET /articles/{article}/highlights
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • article property Modified
GET /articles/{article}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • thread property Modified
        • Thread alternative Modified
GET /api-keys/{key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
DELETE /website-pages/{page}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
DELETE /tags/{tag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tag property Modified
        • newsletter property Modified
        • is_room property Added
DELETE /subscribers/{subscriber}/tags/{tag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • is_room property Added
DELETE /subscribers/{subscriber}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
      • tags property Modified
        • property Modified
DELETE /publishable-keys/{publishable_key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
DELETE /automations/{automation}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
DELETE /api-keys/{key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /newsletters/{newsletter}/threads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • audience_scoped, audience_tag_ids properties Added
GET /newsletters/{newsletter}/tags
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
        • is_room property Added
  • Query
  • is_room query parameter Added
GET /newsletters/{newsletter}/subscribers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter, tags properties Modified
GET /newsletters/{newsletter}/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /newsletters/{newsletter}/sends
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • article, newsletter properties Modified
GET /newsletters/{newsletter}/senders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/publishable-keys
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/insights
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter, subscriber properties Modified
GET /newsletters/{newsletter}/growth
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /newsletters/{newsletter}/events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter, subscriber properties Modified
GET /newsletters/{newsletter}/entitlements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • newsletter property Modified
        • Newsletter alternative Modified
GET /newsletters/{newsletter}/domains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/destinations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/delivery-attempts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/community
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/automations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
GET /newsletters/{newsletter}/articles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • thread property Modified
GET /newsletters/{newsletter}/api-keys
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • newsletter property Modified
Added 1
PATCH /threads/{thread}
9 structure changes including:
3 Additions
6 Modifications
Modified 6
GET /automation-triggers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • context property Modified
POST delivery.bouncedwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • article_id, send_id properties Modified
        • Properties are no longer required
        • Type went from string(uuid) to string(uuid) | null
      • source, run_id, step_id properties Added
POST delivery.clickedwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • article_id, send_id properties Modified
        • Properties are no longer required
        • Type went from string(uuid) to string(uuid) | null
      • source, run_id, step_id properties Added
POST delivery.complainedwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • article_id, send_id properties Modified
        • Properties are no longer required
        • Type went from string(uuid) to string(uuid) | null
      • source, run_id, step_id properties Added
POST delivery.deliveredwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • article_id, send_id properties Modified
        • Properties are no longer required
        • Type went from string(uuid) to string(uuid) | null
      • source, run_id, step_id properties Added
POST delivery.openedwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • article_id, send_id properties Modified
        • Properties are no longer required
        • Type went from string(uuid) to string(uuid) | null
      • source, run_id, step_id properties Added
Added 3
POST automation.run.completedwebhook
POST automation.run.exitedwebhook
POST automation.run.startedwebhook
11 structure changes including:
11 Additions
Added 11
DELETE /automations/{automation}
GET /automation-triggers
GET /automations/{automation}
GET /automations/{automation}/runs
GET /newsletters/{newsletter}/automations
GET /runs/{run}
PATCH /automations/{automation}
POST /automations/{automation}/activate
POST /automations/{automation}/pause
POST /automations/{automation}/steps/{step}/send-test
POST /newsletters/{newsletter}/automations
3 structure changes including:
3 Additions
Added 3
DELETE /subscribers/{subscriber}
PATCH /subscribers/{subscriber}
POST /newsletters/{newsletter}/subscribers
15 structure changes including:
13 Additions
2 Modifications
Modified 2
GET /domains/{domain}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mode property Added
GET /newsletters/{newsletter}/domains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • mode property Added
  • Query
  • mode query parameter Added
Added 13
DELETE /publishable-keys/{publishable_key}
DELETE /website-pages/{page}
GET /newsletters/{newsletter}/publishable-keys
GET /newsletters/{newsletter}/website-pages
GET /website-pages/{page}
PATCH /domains/{domain}
PATCH /website-pages/{page}
POST /newsletters/{newsletter}/publishable-keys
POST /newsletters/{newsletter}/website-assets
POST /newsletters/{newsletter}/website-pages
POST /publishable-keys/{publishable_key}/rotate
POST /website-pages/{page}/publish
POST /website-pages/{page}/unpublish
2 structure changes including:
2 Additions
Added 2
POST /newsletters/{newsletter}/threads
POST /threads/{thread}/messages
1 structure change including:
1 Addition
Added 1
POST /articles/{article}/images