PATCH /customers/{id}/suspend
Bearer auth

Suspend a customer and all its users (cascade suspension). Owner, Distributor, and Reseller (hierarchical) can suspend.

Path parameters

  • id string Required

    Customer Logto ID

Responses

  • 200 application/json

    Customer suspended successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • customer object
        Hide customer attributes Show customer attributes object
        • id string

          Database UUID of the organization

        • logto_id string

          Logto organization ID (use this value for assignment operations)

        • name string

          Organization name

        • description string

          Organization description

        • custom_data object

          Custom organization data

          Additional properties are allowed.

        • suspended_at string(date-time) | null

          Timestamp when the organization was suspended. NULL means enabled, non-NULL means blocked/suspended.

        • suspended_by_org_id string | null

          Organization ID that caused cascade suspension (for resellers and customers only). NULL means directly suspended or not suspended. When set, the entity can only be reactivated by the parent organization that initiated the cascade.

        • rebranding_enabled boolean

          Whether rebranding is active for this organization (directly or inherited from parent)

        • rebranding_org_id string | null

          The organization ID that provides the rebranding (the org where rebranding is configured). Only present when rebranding_enabled is true.

      • suspended_users_count integer

        Number of users that were cascade-suspended

      • suspended_systems_count integer

        Number of systems that were cascade-suspended
  • 400 application/json

    Bad request - validation error

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
PATCH /customers/{id}/suspend 
curl \
 --request PATCH 'https://collect.your-domain.com/api/customers/{id}/suspend' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "customer suspended successfully",
  "data": {
    "customer": {
      "id": "4405ffd0-0aca-44ef-bae2-c8545bce94f4",
      "logto_id": "akkbs6x2wo82",
      "name": "ACME Distribution SpA",
      "description": "Main distributor for Italian and Swiss markets",
      "custom_data": {
        "email": "contact@acme-distribution.com",
        "region": "Italy",
        "contactPerson": "John Smith"
      },
      "suspended_at": "2026-05-04T09:42:00Z",
      "suspended_by_org_id": "string",
      "rebranding_enabled": false,
      "rebranding_org_id": "string"
    },
    "suspended_users_count": 5,
    "suspended_systems_count": 3
  }
}
Response examples (400) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (404) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}