Subscribes an email address to the Nucleus Institute newsletter. Public and rate limited to 5 requests per minute per IP.

Mutation · POST /graphql

Signature

type Mutation {
  subscribeToNewsletter(email: String!): NewsletterSubscriptionApiResponse!
}

Arguments

Name	Type	Required	Description
`email`	`String!`	Yes	Address to subscribe.

Returns

NewsletterSubscriptionApiResponse!

Response envelope for subscribeToNewsletter. data holds the subscription.

Example request

mutation SubscribeToNewsletter($email: String!) {
  subscribeToNewsletter(email: $email) {
    cause
    data {
      _id
      createdAt
      email
      isActive
      updatedAt
    }
    error
    message
    status
    statusCode
    subscriptionRoute
  }
}

curl -X POST https://<api-host>/graphql \
  -H 'Content-Type: application/json' \
  -d '{"query":"mutation SubscribeToNewsletter($email: String!) { subscribeToNewsletter(email: $email) { cause data { _id createdAt email isActive updatedAt } error message status statusCode subscriptionRoute } }","variables":{"email":"jane@example.com"}}'

subscribeToNewsletter

Signature

Arguments

Returns

Example request

On this page