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

# Update Customer

> Updates editable customer fields. This is a partial update — only include the fields you want to change. `customerName` is not updatable here.

Updatable fields: `customerNickname`, `email`, `description`, `phoneNumber`.

<Note>
  Call this endpoint on the campaigns service: `https://campaigns.pingmee.co.il`.
</Note>

Partial update — send only the fields you want to change. For example, to update description alone:

```json theme={null}
{
  "description": "VIP customer, prefers Hebrew"
}
```

Updatable fields: `customerNickname`, `email`, `description`, `phoneNumber`.


## OpenAPI

````yaml POST /customers/{id}
openapi: 3.1.0
info:
  title: Pingmee API
  description: A complete guide to Pingmee micro service architecture.
  version: 1.0.0
servers:
  - url: https://api.pingmee.co.il
security:
  - cookieAuth: []
    ApiKeyAuth: []
paths:
  /customers/{id}:
    servers:
      - url: https://campaigns.pingmee.co.il
        description: Campaigns service
    post:
      summary: Update customer
      description: >-
        Updates editable customer fields. This is a partial update — only
        include the fields you want to change. `customerName` is not updatable
        here.


        Updatable fields: `customerNickname`, `email`, `description`,
        `phoneNumber`.
      parameters:
        - name: id
          in: path
          description: Phone number ID of the customer to update.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        description: Fields to update. Omit fields you do not want to change.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomer'
      responses:
        '200':
          description: Customer updated
          content:
            application/json:
              schema:
                type: object
                required:
                  - customer
                properties:
                  customer:
                    $ref: '#/components/schemas/Customer'
                additionalProperties: false
        '400':
          description: Invalid request or customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UpdateCustomer:
      type: object
      description: Partial customer update. Include only the fields you want to change.
      properties:
        customerNickname:
          type: string
          description: Custom name to identify the customer in the business
        description:
          type: string
          description: Free-text note / description (shown in the conversation sidebar)
        email:
          type: string
          format: email
          description: Customer email address
        phoneNumber:
          type: string
          description: Editable phone number controlled by the business
      additionalProperties: false
    Customer:
      type: object
      required: []
      properties:
        profileImage:
          type:
            - string
            - 'null'
          description: Profile image URL if available
        customerName:
          type: string
          description: The name from WhatsApp or the originating platform
        customerNickname:
          type: string
          description: The name the business gave the customer
        description:
          type: string
          description: >-
            Free-text note / description controlled by the business (shown in
            the conversation sidebar)
        createdAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was created
        lastActiveAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was last active
        email:
          type: string
          format: email
          description: Customer email address
        platform:
          type: string
          enum:
            - whatsapp
            - instagram
            - facebookMessenger
          description: Messaging platform the customer is associated with
        phoneNumberId:
          type: string
          description: Platform-specific phone number identifier
        countryCode:
          type: string
          description: Country calling code
        associatedTo:
          type: string
          description: Business or account the customer is associated with
        parsedPhoneNumber:
          type: string
          description: Normalized phone number if available
      additionalProperties: false
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: header
      name: Cookie
      description: Personal access token from Pingmee Settings → Developer Tools
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Business API key from Pingmee Settings → Developer Tools

````