---
title: "Update an Account"
method: PATCH
path: "/accounts/public/{accountId}"
tags: ["Customers"]
---

# Update an Account

`PATCH /accounts/public/{accountId}`

## Request

- Base URL: `https://api.paperlessparts.com/v1`
- URL: `https://api.paperlessparts.com/v1/accounts/public/{accountId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/paperlessparts/apis/paperless-parts-api/docs/accounts/public/:accountId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Partially update Account attributes (not including associated entities)

## Path parameters

- `accountId` integer, required: The account id

## Request body

- object
  - `name` string: (Required) Account Name (must be non-null and non-blank)
  - `credit_line` number, nullable: An account's credit line
  - `erp_code` string, nullable: Erp code for the account
  - `notes` string, nullable: Account notes
  - `payment_terms` string, nullable: Payment terms; required if `payment_terms_period` are included
  - `payment_terms_period` string, nullable: Payment terms period in days; required if `payment_terms` are included, but can be `null`
  - `phone` string, nullable: Account phone number
  - `phone_ext` string, nullable: Account phone number extension
  - `purchase_orders_enabled` boolean: When `true` any contact associated with this account will be allowed to check out with a purchase order.
  - `salesperson` object, nullable: the accounts salesperson
    - `email` string: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
  - `sold_to_address` object, nullable: The address for the account's headquarters. If a sold_to_address is present on the account then individual fields can be patched otherwise all fields are required.
    - `address1` string: The street address
    - `address2` string, nullable: Unit
    - `city` string: The city of the address
    - `country` string: The three character country abbreviation
    - `postal_code` string: The postal code for the address
    - `state` string: The two character state abbreviation
    - `erp_code` string: The unique identifier for this address record in the ERP
  - `tax_exempt` boolean: When `true`, sales tax will not be added to a quote
  - `tax_rate` number, nullable: Sales tax rate for this Account
  - `type` string: Type of this Account, either customer or vendor
  - `url` string, nullable

## Response `200`

Successful response

- Account
  - `billing_addresses` BillingAddress[]
    - `id` integer
    - `address1` string: (Required)
    - `address2` string, nullable: (Required)
    - `city` string: (Required)
    - `state` string: (Required) State/Province must be specified as standard postal abbreviation
    - `postal_code` string: (Required) US postal codes may optionally contain 4-digit extension, e.g., `'02114-1234'`
    - `country` string: (Required) Country must be ISO 3166-1 alpha-3 code. Currently allowed values are `'USA'`, `'CAN'`.
    - `erp_code` string: The unique identifier for this address record in the ERP
  - `country_code` string, nullable
  - `credit_cards_enabled` boolean
  - `metadata` object, nullable
  - `name` string: (Required) The name of the account
  - `created` string
  - `credit_line` number, nullable: credit line (dollars)
  - `erp_code` string, nullable: The ERP code of the account
  - `id` integer: the ID of the account
  - `notes` string, nullable: Account notes
  - `payment_terms` string, nullable: Payment terms; required if `payment_terms_period` are included
  - `payment_terms_period` integer, nullable: Payment terms period in days; required if `payment_terms` are included, but can be `null`
  - `phone` string, nullable: Account phone number
  - `phone_ext` string, nullable: Account phone number extension
  - `purchase_orders_enabled` boolean: When `true` this account can check out with a purchase order
  - `salesperson` SalesPerson
    - `uuid` string, uuid
    - `first_name` string
    - `last_name` string
    - `email` string, email
    - `erp_code` string
  - `sold_to_address` Address
    - `id` integer
    - `address1` string: (Required)
    - `address2` string, nullable: (Required)
    - `city` string: (Required)
    - `state` string: (Required) State/Province must be specified as standard postal abbreviation
    - `postal_code` string: (Required) US postal codes may optionally contain 4-digit extension, e.g., `'02114-1234'`
    - `country` string: (Required) Country must be ISO 3166-1 alpha-3 code. Currently allowed values are `'USA'`, `'CAN'`.
    - `erp_code` string: The unique identifier for this address record in the ERP
  - `tax_exempt` boolean: When `true`, sales tax will not be added to a quote
  - `tax_rate` number, nullable: Sales tax rate for this account
  - `type` string: Type of account, either customer or vendor
  - `url` string, nullable

---

[API](https://skmtc.dev/paperlessparts/apis/paperless-parts-api.md) - [All operations](https://skmtc.dev/paperlessparts/apis/paperless-parts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paperlessparts/apis/paperless-parts-api/revisions/3eb132ead1fe?raw)