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

# Update Competitor Customer Settings

> Turn renewal tasks in your CRM on or off

Turn [renewal tasks](https://docs.clustr-ai.com/api-reference/get-competitor-customer-settings.md) on or off, or change when
they are due. Workspace admins only (`403 ADMIN_REQUIRED` otherwise). Only the fields you send
change. Tasks are created only where your CRM connection allows creating tasks.

```bash cURL theme={null}
curl -X PUT https://api.clustr-ai.com/api/public/competitor-customers/settings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"renewal_tasks_enabled": true, "renewal_task_due_days": 14}'
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "clustr_updated_by_user_id": "usr_hv7fjqs686d9sydped7fybj00x",
    "renewal_tasks_enabled": true,
    "renewal_task_due_days": 14,
    "updated_by": "5d2c1f3a-8b7e-4c6d-9a0b-1e2f3a4b5c6d",
    "updated_at": "2026-10-09T09:00:00Z",
    "can_edit": true
  }
}
```


## OpenAPI

````yaml PUT /competitor-customers/settings
openapi: 3.1.0
info:
  title: Clustr Public API
  description: >
    Programmatic access to your Clustr network: import connectors, search warm
    intros (opportunities), and manage target accounts.


    ## Authentication

    All endpoints require a Bearer token (API key) in the `Authorization`
    header.


    ```

    Authorization: Bearer <your_api_key>

    ```


    API keys can be created and managed from the [API settings
    page](https://app.clustr-ai.com/api).
  version: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/public
    description: Production
security:
  - BearerAuth: []
paths:
  /competitor-customers/settings:
    put:
      tags:
        - Competitor Monitoring
      summary: Update Competitor Customer Settings
      description: >
        Turn renewal tasks on or off, or change when they are due. Workspace
        admins only. Only

        the fields you send change.
      operationId: updateCompetitorCustomerSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                renewal_tasks_enabled:
                  type: boolean
                  description: >-
                    Create a task for the account owner when a confirmed
                    competitor customer is one of your

                    accounts.
                renewal_task_due_days:
                  type: integer
                  minimum: 1
                  maximum: 90
                  description: >-
                    How many days after its creation the task is due, from 1 to
                    90.
            examples:
              enable:
                summary: Turn renewal tasks on
                value:
                  renewal_tasks_enabled: true
                  renewal_task_due_days: 14
      responses:
        '200':
          description: The settings, as saved
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/CompetitorCustomerSettings'
        '400':
          description: >-
            Nothing to change, or `renewal_task_due_days` is not between 1 and
            90
        '401':
          description: Invalid or missing API key
        '403':
          description: >-
            Not a workspace admin (`ADMIN_REQUIRED`), or competitor monitoring
            is not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CompetitorCustomerSettings:
      type: object
      properties:
        clustr_updated_by_user_id:
          type: string
          description: >-
            The Clustr ID of the member who last changed it, for example
            `usr_j4gy61g1tdqe6tvhqxqm03f37a`.
          example: usr_j4gy61g1tdqe6tvhqxqm03f37a
        renewal_tasks_enabled:
          type: boolean
          description: >-
            Create a CRM task for the account owner when a confirmed competitor
            customer is one of your accounts.
        renewal_task_due_days:
          type: integer
          minimum: 1
          maximum: 90
          example: 14
        updated_by:
          type: string
          nullable: true
          description: >-
            Kept for integrations built before Clustr IDs. New integrations
            should use `clustr_updated_by_user_id`.
        updated_at:
          type: string
          format: date-time
          nullable: true
        can_edit:
          type: boolean
          description: True for workspace admins, the only role that may change these.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            message:
              type: string
              example: Invalid request body
            code:
              type: string
              example: BAD_REQUEST
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: The API key you created on the API settings page of the Clustr app.

````

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