Unsubscribes an email address from the newsletter. Public and rate limited to 5 requests per minute per IP.

Mutation · POST /graphql

Signature

type Mutation {
  unsubscribeFromNewsletter(email: String!): BooleanApiResponse!
}

Arguments

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

Returns

BooleanApiResponse!

Response envelope whose data is a boolean result.

Example request

mutation UnsubscribeFromNewsletter($email: String!) {
  unsubscribeFromNewsletter(email: $email) {
    cause
    data
    error
    message
    status
    statusCode
    subscriptionRoute
  }
}

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

unsubscribeFromNewsletter

Signature

Arguments

Returns

Example request

On this page