YOUHODLERBusiness API
Get access
View as Markdown

postSuspend client

Required capabilityclients.manage

Request

Request URL

POST
POST /clients/{client_id}/suspend

Request Body

application/json
{
  "reason": null
}

Responses

Response

application/json
{
  "created_at": "2026-05-01T10:00:00Z",
  "default_client_account": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "display_name": "Acme Corp",
  "etag": "W/\"a1b2c3d4\"",
  "external_id": "ext-client-0042",
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "metadata": {
    "crm_id": "CRM-001",
    "tier": "premium"
  },
  "resource": "client",
  "scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "status": "active",
  "updated_at": "2026-05-01T10:00:00Z"
}

Resource created successfully.

Related endpoints