Skip to main content
POST
/
admin
/
v3
/
lenders
/
{lenderPublicId}
/
accounts
/
update-status
Update account status
curl --request POST \
  --url https://v3-api.cleargrid.ai/admin/v3/lenders/{lenderPublicId}/accounts/update-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    {
      "status": 5,
      "debtorCompanyId": "customer_001",
      "accountId": "ORD-2025-001"
    },
    {
      "status": 6,
      "debtorCompanyId": "customer_002",
      "accountId": "ORD-2025-045"
    }
  ]
}
'
{
  "code": 200,
  "message": "success",
  "body": "Processing started successfully",
  "errors": []
}
This endpoint is used for updating account-level statuses, such as marking an account as disputed or flagging a customer as do not contact. Unlike the Create & Update Account endpoint which handles financial data, this endpoint specifically manages operational statuses that affect how accounts are handled within Command.

​
Request

​
Endpoint

POST {{base_url}}/lenders/{{lenderPublicId}}/accounts/update-status
EnvironmentBase URL
Productionhttps://v3-api.cleargrid.ai/admin/v3
Staginghttps://stage-v3-api.cleargrid.ai/admin/v3

​
Headers

​
Authorization
string
required
Bearer token obtained from the Lender Login endpoint. Format: Bearer <access_token>

​
Body Parameters

​
accounts
array
required
An array of account status update objects.

​
Example Request

{
  "accounts": [
    {
      "status": 5,
      "debtorCompanyId": "customer_001",
      "accountId": "ORD-2025-001"
    },
    {
      "status": 6,
      "debtorCompanyId": "customer_002",
      "accountId": "ORD-2025-045"
    }
  ]
}

curl -X POST https://v3-api.cleargrid.ai/admin/v3/lenders/{lenderPublicId}/accounts/update-status \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "accounts": [
      {
        "status": 5,
        "debtorCompanyId": "customer_001",
        "accountId": "ORD-2025-001"
      }
    ]
  }'

​
Status Definitions

Disputed (5)

Marks the specified account as disputed. When an account is flagged as disputed:
  • The account is visually flagged in Command’s CRM interface
  • Collection agents are alerted to the dispute status
  • Depending on your organization’s configuration, automated communications may be paused
  • The dispute should be resolved before collection activities resume

Do Not Contact (6)

Marks the specified customer as do not contact. This is a customer-level flag that:
  • Blocks all outbound communication channels (WhatsApp, Email, SMS, Voice) for the customer
  • Applies across all accounts belonging to this customer
  • Overrides any automated communication workflows
  • Remains in effect until explicitly removed
The Do Not Contact (status 6) flag applies at the customer level, meaning it affects all accounts linked to that debtorCompanyId, not just the specified accountId. Use this status carefully, as it will halt all outbound communications across the customer’s entire portfolio.

​
Response

Status updates have been accepted and processing has started in the background.
{
  "code": 200,
  "message": "success",
  "body": "Processing started successfully",
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
lenderPublicId
string
required

Lender public ID (UUID) returned by the Lender Login endpoint.

Body

application/json
​
accounts
object[]
required

Array of account status update objects.

Response

Processing started successfully

​
code
integer
​
message
string | null
​
body
string
​
errors
object[]