---
title: "Save Keyword Sync Config"
method: PATCH
path: "/intent/keywords/{keyword_id}/sync-config"
tags: ["Signals"]
---

# Save Keyword Sync Config

`PATCH /intent/keywords/{keyword_id}/sync-config`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/intent/keywords/{keyword_id}/sync-config`
- Auth: HTTP bearer

Wire this keyword to a list (upsert).

`auto_sync_enabled: true` is the consequential field: from then on the
keyword's matches are pushed into `list_id` on a schedule, and anything
downstream of that list runs on the people it found.

## Path parameters

- `keyword_id` string, uuid, required: The keyword's id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- KeywordSyncConfigRequest: Wire a keyword to a list, optionally on a schedule.
  - `icp_id` string, uuid, nullable: Score matches against this ICP.
  - `committee_id` string, uuid, nullable: Buying committee whose personas are exported.
  - `export_mode` 'signals_only' | 'icp_plus_signals' | 'all_icp_personas': `signals_only` exports only the people a signal named; `icp_plus_signals` adds the ICP's personas at those companies; `all_icp_personas` exports every persona regardless of signal.
  - `list_id` integer, nullable: The list matches are pushed into.
  - `auto_sync_enabled` boolean: Push on a schedule, without anyone calling anything, rather than only on request.

## Response `200`

Successful Response

- ApiResponseIntentPayload
  - `data` IntentPayload, required: One intent object or handler response. Open-shaped: these payloads carry corpus detail that grows with the corpus. A list result is returned under `items`.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)