bulkRejectPendingCustomers

Requires a tenant administrator.

Rejects many pending customers in one call by setting them inactive, and reports, for each, whether it succeeded. Tenant admins only.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation BulkRejectPendingCustomers($target: PendingBulkTargetInput!) {
  bulkRejectPendingCustomers(target: $target) {
    batchId
    failed
    succeeded
    total
    results {
      id
      code
      name
      message
      success
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation BulkRejectPendingCustomers($target: PendingBulkTargetInput!) {\n  bulkRejectPendingCustomers(target: $target) {\n    batchId\n    failed\n    succeeded\n    total\n    results {\n      id\n      code\n      name\n      message\n      success\n    }\n  }\n}",
  "variables": {
    "target": {}
  }
}
EOF

Variables:

{
  "target": {}
}

Response:

{
  "data": {
    "bulkRejectPendingCustomers": {
      "batchId": "string",
      "failed": 0,
      "succeeded": 0,
      "total": 0,
      "results": [
        {
          "id": "id",
          "code": "string",
          "name": "string",
          "message": "string",
          "success": true
        }
      ]
    }
  }
}

bulkRejectPendingCustomers(
  reason: String
  target: PendingBulkTargetInput!
): BulkPendingActionResult!

Arguments

bulkRejectPendingCustomers.reason ● String scalar

Why the customers are being rejected. Optional.

bulkRejectPendingCustomers.target ● PendingBulkTargetInput! non-null input

The pending customers to reject.

Type

BulkPendingActionResult object

The outcome of approving or rejecting several pending customers.