Skip to main content

listRemoveUsers Mutation

Description​

Removes buyers from a customer list. Buyers who have opted out are not removed. The list member count is automatically updated after removing buyers.

mutation listRemoveUsers($listRef: ID!, $userRefs: [ID!]!) {
  listRemoveUsers(listRef: $listRef, userRefs: $userRefs) {
    _id
    id
    title
    description
    created
    count
    system
  }
}

Variables​

{
    "listRef": "9ab9d08ef22214bc1b545ebd",
    "userRefs": [
        "cbb27e1ed711547ebfa53b4c"
    ]
}

Response​

{
    "listRemoveUsers": {
        "_id": "d299da0e656f669c19fbf0d6",
        "id": 4836428593442,
        "title": "example",
        "description": "example",
        "created": 1716309246871,
        "count": 10,
        "system": true
    }
}

Arguments​

NameTypeDescription
listRefID!Reference ID of the customer list to remove buyers from.
userRefs[ID!]!List of buyer reference IDs to remove from the customer list.

Returns​

List