listOptout Mutation

Description

Unsubscribes an email address from a customer list.

mutation listOptout($listRef: ID!, $email: String!, $reason: String!) {
  listOptout(listRef: $listRef, email: $email, reason: $reason)
}

Variables

{
    "listRef": "cd89fedf67b9de721e0e1dbd",
    "email": "email@example.com",
    "reason": "reason"
}

Response

{
    "listOptout": "example"
}

Arguments

Name	Type	Description
listRef	ID!	Customer list identifier.
email	String!	Email address to unsubscribe.
reason	String!	Reason for unsubscribing.

Returns

String