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

# Update Customer

> Partially update a platform customer's name, company name, or address. DGFT credentials are never returned and are changed via the validate endpoint instead.

Update a customer's `name`, `companyName`, or `address`. All fields are optional; only the fields you send are changed. To change the stored DGFT password, use [Validate Customer](/api-reference/customer/validate) instead.

### Request example

```bash theme={"dark"}
curl --location --request PATCH 'https://ebrcapi.eximfiles.io/api/v1/platform-customers/ee849a90-7a28-49b4-8cb2-8e31041650a2' \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "address": "SIDCO Industrial Estate, Tiruppur, Tamil Nadu"
  }'
```

### Response example

```json theme={"dark"}
{
  "success": true,
  "data": {
    "id": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
    "name": "Rohan Mehta",
    "email": "finance@suryatextiles.example.com",
    "type": "customer",
    "companyName": "Surya Textile Exports Pvt Ltd",
    "address": "SIDCO Industrial Estate, Tiruppur, Tamil Nadu",
    "platformId": "1f0c9a52-3b41-4d78-9e26-7a8b5c4d3e2f",
    "isActive": true,
    "createdAt": "2026-07-22T10:15:04.874Z",
    "updatedAt": "2026-07-22T11:02:18.330Z"
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T11:02:18.352Z"
}
```

### Errors

* `404` when no customer with that id belongs to your account.
* `400` with `property x should not exist` for fields outside `name`, `companyName`, `address`. See [common validation errors](/errors#common-validation-errors).

### Next steps

* [Get the customer](/api-reference/customer/getById) to confirm the change.
* [Validate DGFT credentials](/api-reference/customer/validate) if the DGFT password changed.
* [Delete the customer](/api-reference/customer/delete) if they are offboarding.


## OpenAPI

````yaml PATCH /platform-customers/{id}
openapi: 3.1.0
info:
  title: eBRC API
  description: >-
    REST API for generating and managing electronic Bank Realization
    Certificates (eBRC) through DGFT's GenEBRC module. Onboard exporters,
    validate their DGFT credentials, pull inward remittance (IRM) data, submit
    certificate generation requests singly or in bulk, and track them to
    completion. All JSON responses are wrapped in the standard envelope {
    success, data, statusCode, timestamp }; the schemas on each endpoint
    describe the data field.
  contact:
    name: Eximfiles support
    email: amin@eximfiles.io
  version: 1.0.0
servers:
  - url: https://ebrcapi.eximfiles.io/api/v1
    description: Production
  - url: https://ebrcapi.dev.eximfiles.com/api/v1
    description: Sandbox
security:
  - x-api-key: []
paths:
  /platform-customers/{id}:
    patch:
      summary: Update a platform customer
      description: Partially update a platform customer's name, company name or address.
      operationId: updatePlatformCustomer
      parameters:
        - name: id
          in: path
          required: true
          description: The customer ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                companyName:
                  type: string
                address:
                  type: string
      responses:
        '200':
          description: Customer updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the platform customer
        name:
          type: string
        email:
          type: string
          format: email
        type:
          type: string
          enum:
            - customer
          default: customer
        companyName:
          type: string
        address:
          type: string
        platformId:
          type: string
          description: Platform user ID that owns this customer
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````