Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Update an account

Updates properties on an existing account.

Note: To manage entity relationships, use the /entity_relationships endpoints. Status changes should use dedicated endpoints (/activate, /deactivate, /close).

Idempotency

The Idempotency-Key header is required.

patch/v0/accounts/{id}

Path parameters

idstring required

The ID of the Account object.

Example:account_xyz123

Account ID

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

application_idstring

Unique identifier for the application. Prefixed with application_.

capabilitiesAccountCapability[]

List of items that inform Lead how the Account will be used

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example request

{
  "application_id": "application_xyz123",
  "details": {
    "credit": {
      "currency": "USD"
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}

Response

Account updated successfully.

idstring

The ID of the Account object.

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

application_idstring

Unique identifier for the application. Prefixed with application_.

status'active' | 'inactive' | 'closed'

Current state of the account

status_reason'client_closed' | 'entity_closed' | 'frozen' | 'dormant' | 'active' | 'paid_off' | 'charged_off' | 'canceled' | 'other'

Machine-readable reason for the current status

capabilitiesAccountCapability[]

List of items that inform Lead how the Account will be used

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

client_account_idstring

Client-provided identifier for the account. Optional: present only for accounts created via file upload, and omitted for accounts created through the API, which are identified solely by their server-generated ID.

Example response

{
  "id": "account_xyz123",
  "application_id": "application_xyz123",
  "details": {
    "credit": {
      "currency": "USD"
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}