---
title: "Update crm sync sources"
method: POST
path: "/api/v1/business/crm-sync-sources/update"
tags: ["business"]
---

# Update crm sync sources

`POST /api/v1/business/crm-sync-sources/update`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/crm-sync-sources/update`
- Auth: OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Change one sync source: pause, resume or retire it, switch a segment's auto-follow, or change a kept list's cadence. Retiring never unfollows contacts; retiring a kept list stops its schedule and keeps its versions.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- BusinessCrmSyncSourcesUpdateRequest
  - `id` string, uuid, required: The sync source's id
  - `change` union, required
    - object
      - `kind` 'pause', required
    - object
      - `kind` 'resume', required
    - object
      - `kind` 'retire', required
    - object
      - `kind` 'auto_follow', required
      - `value` boolean, required
    - object
      - `kind` 'cadence', required
      - `cadence` 'monthly' | 'weekly', required

## Response `200`

Success.

- BusinessCrmSyncSourcesUpdateResponse
  - `status` 'active' | 'paused' | 'retired', required
  - `autoFollow` boolean, nullable, required
  - `cadence` 'daily' | 'weekly' | 'monthly', nullable, required
  - `nextSyncAt` string, date-time, nullable, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)