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

# Update settings

> Replaces the instance's behavior settings. Send the full state — omitted fields return to their defaults.



## OpenAPI

````yaml /en/api-reference/openapi.json post /instance/settings
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    Multi-tenant WhatsApp API. Send messages and manage webhooks through a
    single surface.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /instance/settings:
    post:
      tags:
        - Instance
      summary: Update settings
      description: >-
        Replaces the instance's behavior settings. Send the full state — omitted
        fields return to their defaults.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceSettingsBody'
      responses:
        '200':
          $ref: '#/components/responses/InstanceSettings'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  schemas:
    InstanceSettingsBody:
      type: object
      required:
        - alwaysOnline
        - rejectCall
        - readMessages
        - ignoreGroups
        - ignoreStatus
      properties:
        alwaysOnline:
          type: boolean
          description: Keeps the instance always appearing online.
          example: false
        rejectCall:
          type: boolean
          description: Automatically rejects incoming calls.
          example: true
        msgRejectCall:
          type: string
          description: >-
            Message sent automatically when a call is rejected. Used only when
            `rejectCall` is `true`.
          example: I don't take calls here.
        readMessages:
          type: boolean
          description: Automatically marks incoming messages as read.
          example: false
        ignoreGroups:
          type: boolean
          description: Ignores group messages — no webhook is fired for them.
          example: false
        ignoreStatus:
          type: boolean
          description: Ignores status updates — no webhook is fired for them.
          example: false
    InstanceSettingsResult:
      type: object
      required:
        - alwaysOnline
        - rejectCall
        - msgRejectCall
        - readMessages
        - ignoreGroups
        - ignoreStatus
      properties:
        alwaysOnline:
          type: boolean
          description: Keeps the instance always appearing online.
          example: false
        rejectCall:
          type: boolean
          description: Automatically rejects incoming calls.
          example: true
        msgRejectCall:
          type: string
          description: >-
            Message sent automatically when a call is rejected. Used only when
            `rejectCall` is `true`.
          example: I don't take calls here.
        readMessages:
          type: boolean
          description: Automatically marks incoming messages as read.
          example: false
        ignoreGroups:
          type: boolean
          description: Ignores group messages — no webhook is fired for them.
          example: false
        ignoreStatus:
          type: boolean
          description: Ignores status updates — no webhook is fired for them.
          example: false
  responses:
    InstanceSettings:
      description: Instance behavior settings.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/InstanceSettingsResult'
    Error:
      description: Error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Account token (`zpfy_acct_...`) — manages instances and webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Instance token (`zpfy_inst_...`) — sends messages.

````