PUT/entity

Update an account

Update an account, e.g. change its status to active or inactive.

Required Attributes

statusstring

'active' or 'inactive'

Example: "inactive"

metadataobject

Arbitrary JSON

entity_idstringrequired

Account to update

Example: "ent_0274ef47"

Request

PUT/entity

curl --location 'https://api.ledgr.dev/v1/entity' \
--header 'Authorization: {api_key}' \
--header 'Content-Type: application/json' \
--data '{
  "status": "inactive",
  "metadata": {},
  "entity_id": "ent_0274ef47"
}'

Response

The updated account

{
  "entity": {
    "entity_id": "ent_0274ef47"
  },
  "status": "success"
}