Skip to main content

Update Account By Id

PUT /v1/account/:id

Updates an existing account by its unique identifier. This endpoint validates the provided input data, applies modifications to the existing record, and saves the updated account details in the system. It ensures that only editable fields are modified and returns the full updated resource upon success. Common use cases include changing the account name, updating postal addresses, or modifying account status and country information.

Request Body​

{
    "name": "Updated Account"
  }

Response Example​

{
  "status": {
    "active": true
  },
  "type": "customer",
  "number": "123456789",
  "country": "EX",
  "name": "Updated Account",
  "address": {
    "postal": {
      "line2": "",
      "street": "Example Street 1",
      "zip": "1111",
      "city": "Example City",
      "country": "Exampleland",
      "state": "",
      "editable": true,
      "_id": "postal-id-1"
    }
  },
  "id": "account-id-1"
}