activateCustomer

Requires a tenant administrator.

Approves a customer so it becomes active, typically one that registered itself and is waiting in the pending queue. Can assign the owning sales rep in the same step. 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 ActivateCustomer($id: ID!) {
  activateCustomer(id: $id) {
    id
    code
    registrationNumber
    name
    customerTierName
    displayName
    addresses {
      id
      postalCode
      contactName
      type
      createdAt
      addressLine1
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ActivateCustomer($id: ID!) {\n  activateCustomer(id: $id) {\n    id\n    code\n    registrationNumber\n    name\n    customerTierName\n    displayName\n    addresses {\n      id\n      postalCode\n      contactName\n      type\n      createdAt\n      addressLine1\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "activateCustomer": {
      "id": "id",
      "code": "string",
      "registrationNumber": "string",
      "name": "string",
      "customerTierName": "string",
      "displayName": "string",
      "addresses": [
        {
          "id": "id",
          "postalCode": "string",
          "contactName": "string",
          "type": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "addressLine1": "string"
        }
      ]
    }
  }
}

activateCustomer(
  assignedSalesRepId: ID
  id: ID!
): Customer!

Arguments

activateCustomer.assignedSalesRepId ● ID scalar

The sales rep to set as the customer's owner on approval. Leave it out to approve without assigning a rep. Must be a user in your organization.

activateCustomer.id ● ID! non-null scalar

The ID of the customer.

Type

Customer object

A customer: a partner with the customer role.