Skip to main content

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": "118d7611fc3ebdff44561f0e",
"email": "email@example.com",
"reason": "reason"
}

Response

{
"listOptout": "example"
}

Arguments

NameTypeDescription
listRefID!Customer list identifier.
emailString!Email address to unsubscribe.
reasonString!Reason for unsubscribing.

Returns

String