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

# Update mailback settings

> Partial update — an omitted field is unchanged, an empty email or password clears it. Passwords are write-only. Turning on cams_automation_enabled unlocks the schedule and request endpoints; it needs the email and CAMS password to be set before a report can actually be requested. An email already registered to another account is 409.



## OpenAPI

````yaml /openapi.yaml patch /api/mailback-automation/v1/settings
openapi: 3.0.3
info:
  title: MF Atlas API
  version: 1.0.0
servers:
  - description: Sandbox
    url: https://api-sandbox.mf-atlas.space
  - description: Production
    url: https://api.mf-atlas.space
security:
  - bearerAuth: []
paths:
  /api/mailback-automation/v1/settings:
    patch:
      tags:
        - mailback-automation
      summary: Update mailback settings
      description: >-
        Partial update — an omitted field is unchanged, an empty email or
        password clears it. Passwords are write-only. Turning on
        cams_automation_enabled unlocks the schedule and request endpoints; it
        needs the email and CAMS password to be set before a report can actually
        be requested. An email already registered to another account is 409.
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cams_automation_enabled:
                  description: >-
                    Whether the CAMS report automation (schedule and on-demand
                    requests) is turned on. Needs the email and CAMS password
                    above.
                  type: boolean
                cams_zip_password:
                  description: >-
                    The password your CAMS reports are protected with (also used
                    when the automation requests CAMS reports). Write-only.
                    Empty clears it.
                  type: string
                email:
                  description: >-
                    The registered email address CAMS and KFintech send your
                    mailback reports to. Unique across accounts. Empty clears
                    it.
                  type: string
                kfin_zip_password:
                  description: >-
                    The password your KFintech reports are protected with.
                    Write-only. Empty clears it.
                  type: string
                reports_enabled:
                  description: >-
                    Whether the CAMS / KFintech report emails forwarded to the
                    inbound address are ingested into holdings.
                  type: boolean
              type: object
        description: Settings to change
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      cams_automation_enabled:
                        type: boolean
                      cams_zip_password_set:
                        type: boolean
                      email:
                        type: string
                      inbound_address:
                        description: >-
                          The address your mailbox must automatically forward
                          the CAMS and KFintech report emails to.
                        type: string
                      kfin_zip_password_set:
                        type: boolean
                      reports_enabled:
                        type: boolean
                    required:
                      - cams_automation_enabled
                      - cams_zip_password_set
                      - kfin_zip_password_set
                      - reports_enabled
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                type: object
          description: Updated settings
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: Opaque bearer token from POST /api/auth/v1/token
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.