# Update Consumer Number

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/biller/bulk:
    patch:
      summary: Update Consumer Number
      deprecated: false
      description: >-
        This API is used to update configuration details of one or more
        registered consumer numbers. It allows modification of auto-fetch
        settings, branch association, auto-debit preference, and contact
        details.


        The API supports bulk updates by accepting a list of company biller IDs,
        enabling efficient management of multiple consumer records in a single
        request.
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Consumer Number Apis
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                companyBillerIds:
                  type: array
                  items:
                    type: string
                  description: >-
                    List of companyBillerIds on which update action to be
                    performed.
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - INACTIVE
                  x-apidog-enum:
                    - value: ACTIVE
                      name: ''
                      description: >-
                        Auto-fetch is enabled. The system will automatically
                        fetch the bill at configured intervals.
                    - value: INACTIVE
                      name: ''
                      description: >-
                        Auto-fetch is disabled. The system will not
                        automatically fetch the bill.
                  description: To handle auto fetch on the consumer number.
                companyBranchCodeId:
                  type: string
                  description: Add new branch code on the existing consumer number.
                autoDebit:
                  type: boolean
                  description: To enable auto debit on the consumer number.
                keyContactEmail:
                  type: string
                  description: >-
                    Email address of the contact person to whom bill related
                    emails to be triggered. Multiple emails can be shared comma
                    separated.
              required:
                - companyBillerIds
              x-apidog-orders:
                - companyBillerIds
                - status
                - companyBranchCodeId
                - autoDebit
                - keyContactEmail
            examples:
              '1':
                value:
                  companyBillerIds:
                    - CB3283092843
                    - CB3483284230D
                  status: ACTIVE
                  companyBranchCodeId: CB34823908423DJ
                  autoDebit: false
                  keyContactEmail: true@enkash.com
                summary: Update
              '2':
                value:
                  companyBillerIds:
                    - CB3283092843
                    - CB3483284230D
                  status: INACTIVE
                  companyBranchCodeId: CB34823908423DJ
                  autoDebit: false
                summary: Update
              '3':
                value:
                  companyBillerIds:
                    - CB3283092843
                  status: ACTIVE
                summary: Auto Fetch update
              '4':
                value:
                  companyBillerIds:
                    - CB3283092843
                  autoDebit: true
                summary: Auto Debit update
              '5':
                value:
                  companyBillerIds:
                    - CB3283092843
                  companyBranchCodeId: CB34823908423DJ
                summary: Branch update
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_code:
                    type: integer
                  response_message:
                    type: string
                  payload:
                    type: string
                required:
                  - response_code
                  - response_message
                  - payload
                x-apidog-orders:
                  - response_code
                  - response_message
                  - payload
              examples:
                '1':
                  summary: Success
                  value:
                    response_code: 0
                    response_message: Success
                    payload: Successfully updated
                '2':
                  summary: Failure
                  value:
                    response_code: 1
                    response_message: invalid companyBranchCode in request
                    payload: invalid companyBranchCode in request
                '3':
                  summary: Failure
                  value:
                    response_code: 1
                    response_message: At least one of the companyBillerIds in request is invalid
                    payload: At least one of the companyBillerIds in request is invalid
          headers: {}
          x-apidog-name: Success
      security:
        - bearer: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Consumer Number Apis
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-29260782-run
components:
  schemas: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```