Admin API - Member endpoints

Nat_Ring · August 29, 2023, 5:28pm

Hello!

I’m using the hosted version of Ghost, so it’s on the the latest version, but I’m treating it as a headless CMS. I generate a static frontend with Next.js to display all of our content and posts. This has worked great but using this strategy does have its drawbacks. For one, it disables unsubscribing from newsletters via the email link. (It also breaks the user account management functionality but that is a larger issue.) The unsubscribe link that is generated includes the hosted version of my URL along with the user uuid and newsletter uuid.

I think that I’ll be able to intercept the request in my Next.js app, but is it possible to get a member by uuid since I don’t have access to the id? If that is possible, my hope was to update that specific user to remove the supplied newsletter uuid from the newsletters parameter.

I don’t see a specific way to do this in the API docs but was wondering if others had found a workaround.

vikaspotluri123 · August 29, 2023, 6:50pm

Looking at the unsubscribe controller, it looks like it’s just a redirect to the home page, where I assume portal takes over:

github.com

TryGhost/Ghost/blob/24300120c29e901c9ebc2adffff1692738f516f8/ghost/core/core/frontend/services/routing/controllers/unsubscribe.js

const debug = require('@tryghost/debug')('services:routing:controllers:unsubscribe');
const url = require('url');

const urlUtils = require('../../../../shared/url-utils');

module.exports = async function unsubscribeController(req, res) {
    debug('unsubscribeController');

    const {query} = url.parse(req.url, true);

    if (!query || !query.uuid) {
        res.writeHead(400);
        return res.end('Email address not found.');
    }

    const redirectUrl = new URL(urlUtils.urlFor('home', true));
    redirectUrl.searchParams.append('uuid', query.uuid);
    if (query.newsletter) {
        redirectUrl.searchParams.append('newsletter', query.newsletter);
    }

This file has been truncated. show original

Nat_Ring · August 29, 2023, 7:40pm

Thanks for the source link! Because we’re using our Ghost instance as a headless CMS we’ve made the normal Ghost site private, so unfortunately we lose out on a lot of that base functionality. I think it would be a very steep uphill battle trying to get parts of the normal site to work accordingly which was why I was hoping to accomplish it via the API.

vikaspotluri123 · August 29, 2023, 8:49pm

How are you handling memberships (auth/subscription management/etc) on your headless site? If you’re using portal, supporting the unsubscribe URL should be pretty painless.

Nat_Ring · August 30, 2023, 1:56pm

Unfortunately, we’re not.

Users are able to sign up via a custom form which sends a request to /members/api/send-magic-link/. The rest of the portal/membership functionality is inaccessible or unsupported. We do want to get that working but know that implementing that will be a bigger lift.

vikaspotluri123 · August 30, 2023, 2:33pm

Ah,

In that case, I think this is the Portal logic to handle newsletter subscription (if you want to extract it to your headless app):

github.com

TryGhost/Ghost/blob/310f01da0b78606ee536013c43459266760d17cb/apps/portal/src/components/pages/UnsubscribePage.js#L60-L92


      
          const memberData = await ghostApi.member.newsletters({uuid: pageData.uuid});
          
          setMember(memberData);
          const memberNewsletters = memberData?.newsletters || [];
          setSubscribedNewsletters(memberNewsletters);
          if (siteNewsletters?.length === 1 && !commentsEnabled) {
              // Unsubscribe from all the newsletters, because we only have one
              const updatedData = await updateMemberNewsletters({
                  api: ghostApi,
                  memberUuid: pageData.uuid,
                  newsletters: []
              });
              setSubscribedNewsletters(updatedData.newsletters);
          } else if (pageData.newsletterUuid) {
              // Unsubscribe link for a specific newsletter
              const updatedData = await updateMemberNewsletters({
                  api: ghostApi,
                  memberUuid: pageData.uuid,
                  newsletters: memberNewsletters?.filter((d) => {
                      return d.uuid !== pageData.newsletterUuid;

This file has been truncated. show original

URL Building logic:

github.com

TryGhost/Ghost/blob/310f01da0b78606ee536013c43459266760d17cb/apps/portal/src/utils/api.js#L283-L308


      
          async updateNewsletters({uuid, newsletters, enableCommentNotifications}) {
              let url = endpointFor({type: 'members', resource: `member/newsletters`});
              url = url + `?uuid=${uuid}`;
              const body = {
                  newsletters
              };
          
              if (enableCommentNotifications !== undefined) {
                  body.enable_comment_notifications = enableCommentNotifications;
              }
          
              return makeRequest({
                  url,
                  method: 'PUT',
                  headers: {
                      'Content-Type': 'application/json'
                  },
                  body: JSON.stringify(body)
              }).then(function (res) {
                  if (res.ok) {

This file has been truncated. show original

Nat_Ring · August 31, 2023, 2:35pm

Ohh, awesome thank you for the suggestions. Let me give this a shot and I’ll respond whether or not it’s successful!

Topic		Replies	Views
Adding member via @tryghost/admin-api does not send subscribe or signup email Developer help	0	460	August 12, 2021
Subscription Form API Developer help	3	1554	November 7, 2022
Headless CMS: Accepting / Reading Subscribe-Invite Token from Magic-Link Email Developer help	0	404	November 14, 2021
Unsubscribe doesn't work with disabled Portal Developer help	2	106	October 21, 2023
Newsletter ID Ghost Dashboard \| Create member Developer help	1	228	October 13, 2022

Admin API - Member endpoints

Related Topics