> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit the given customer.



## OpenAPI

````yaml api-reference/openapi.json put /api/customers/{id}
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/customers/{id}:
    put:
      tags:
        - Customers
      summary: Edit the given customer.
      operationId: CustomersController_editCustomer
      parameters:
        - name: Authorization
          in: header
          description: >-
            Value must be 'Bearer <token>' where <token> is an API key prefixed
            with 'bc_' or a JWT token.
          required: true
          schema:
            type: string
            example: Bearer bc_1234567890abcdef
        - name: organization-id
          in: header
          description: >-
            Required if Authorization is a JWT token. The organization ID to
            operate within.
          required: true
          schema:
            type: string
        - name: id
          required: true
          in: path
          schema:
            type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditCustomerDto'
      responses:
        '200':
          description: The customer has been successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseDto'
components:
  schemas:
    EditCustomerDto:
      type: object
      properties:
        billingAddress1:
          type: string
          description: Billing address line 1
        billingAddress2:
          type: string
          description: Billing address line 2
        billingAddressCity:
          type: string
          description: Billing address city
        billingAddressCountry:
          type: string
          description: Billing address country
        billingAddressEmail:
          type: string
          description: Billing address email
        billingAddressPostcode:
          type: string
          description: Billing address postcode
        billingAddressPhone:
          type: string
          description: Billing address phone
        billingAddressState:
          type: string
          description: Billing address state
        shippingAddress1:
          type: string
          description: Shipping address line 1
        shippingAddress2:
          type: string
          description: Shipping address line 2
        shippingAddressCity:
          type: string
          description: Shipping address city
        shippingAddressCountry:
          type: string
          description: Shipping address country
        shippingAddressEmail:
          type: string
          description: Shipping address email
        shippingAddressPostcode:
          type: string
          description: Shipping address postcode
        shippingAddressPhone:
          type: string
          description: Shipping address phone
        shippingAddressState:
          type: string
          description: Shipping address state
        customerType:
          type: string
          description: Customer type
        salutation:
          type: string
          description: Salutation
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        companyName:
          type: string
          description: Company name
        displayName:
          type: string
          description: Display name
        website:
          type: string
          description: Website
        email:
          type: string
          description: Email
        workPhone:
          type: string
          description: Work phone
        personalPhone:
          type: string
          description: Personal phone
        note:
          type: string
          description: Note
        active:
          type: boolean
          description: Active status
      required:
        - customerType
        - displayName
    CustomerResponseDto:
      type: object
      properties:
        balance:
          type: number
          example: 1500
        currencyCode:
          type: string
          example: USD
        openingBalance:
          type: number
          example: 1000
        openingBalanceAt:
          format: date-time
          type: string
          example: '2024-01-01T00:00:00Z'
        openingBalanceExchangeRate:
          type: number
          example: 1
        openingBalanceBranchId:
          type: number
          example: 1
        salutation:
          type: string
          example: Mr.
        firstName:
          type: string
          example: John
        lastName:
          type: string
          example: Doe
        companyName:
          type: string
          example: Acme Corporation
        displayName:
          type: string
          example: John Doe - Acme Corporation
        email:
          type: string
          example: john.doe@acme.com
        workPhone:
          type: string
          example: +1 (555) 123-4567
        personalPhone:
          type: string
          example: +1 (555) 987-6543
        website:
          type: string
          example: https://www.acme.com
        billingAddress1:
          type: string
          example: 123 Business Ave
        billingAddress2:
          type: string
          example: Suite 100
        billingAddressCity:
          type: string
          example: New York
        billingAddressCountry:
          type: string
          example: United States
        billingAddressEmail:
          type: string
          example: billing@acme.com
        billingAddressPostcode:
          type: string
          example: '10001'
        billingAddressPhone:
          type: string
          example: +1 (555) 111-2222
        billingAddressState:
          type: string
          example: NY
        shippingAddress1:
          type: string
          example: 456 Shipping St
        shippingAddress2:
          type: string
          example: Unit 200
        shippingAddressCity:
          type: string
          example: Los Angeles
        shippingAddressCountry:
          type: string
          example: United States
        shippingAddressEmail:
          type: string
          example: shipping@acme.com
        shippingAddressPostcode:
          type: string
          example: '90001'
        shippingAddressPhone:
          type: string
          example: +1 (555) 333-4444
        shippingAddressState:
          type: string
          example: CA
        note:
          type: string
          example: Important client with regular monthly orders
        active:
          type: boolean
          example: true
        createdAt:
          format: date-time
          type: string
          example: '2024-01-01T00:00:00Z'
        updatedAt:
          format: date-time
          type: string
          example: '2024-01-01T00:00:00Z'
        localOpeningBalance:
          type: number
          example: 1000
        closingBalance:
          type: number
          example: 1500
      required:
        - balance
        - currencyCode
        - openingBalance
        - openingBalanceAt
        - openingBalanceExchangeRate
        - displayName
        - note
        - active
        - createdAt
        - updatedAt
        - localOpeningBalance
        - closingBalance

````