Update a keyword set

patch

https://uapi.demandbase.com/data/intent/v1/keyword-sets/{keywordSetId}

Applies a partial update. Every property is optional and any property omitted retains its
stored value, but at least one must be supplied — an absent, empty or wholly unrecognized
body is rejected with 400-242.

Property	Effect
`name`	Replaced when present
`isCompetitor`	Replaced when present
`keywords.add`	Adds values not already present, matched case-insensitively
`keywords.remove`	Removes matching values, matched case-insensitively
`seedUrls.add`	Adds URLs not already present, matched byte-for-byte
`seedUrls.remove`	Removes matching URLs, matched byte-for-byte

Adding a value that already exists, and removing one that is not present, both succeed as
no-ops, so the same request can safely be replayed after a timeout without first reading
the set back. A keywords or seedUrls object that is present must request at least one
operation; {"keywords": {}} is rejected with 400-241. The
same value must not appear in both add and remove for one collection (400-243) —
for keywords that comparison is case-insensitive, so "Zero Trust" in one array and
"zero trust" in the other is a conflict, while for seed URLs it is byte-for-byte, so two
URLs differing only in case may legitimately appear in both.

Unrecognized properties are ignored, so a misspelled property is treated as absent. This is
safe here because PATCH never clears a collection that was not explicitly named.

There is no full-replace (PUT) or delete (DELETE) endpoint in this version. To clear a
collection, remove its current values explicitly. To delete a keyword set, use the
Demandbase One UI.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

keywordSetId

int64

required

≥ 1

Identifier of the keyword set. Must be a positive integer; anything else is rejected with
400-236.

Body Params

Body for a partial update. Every property is optional and any property omitted retains its
stored value, but at least one must be supplied. Unrecognized properties are ignored, so a
body naming none of these properties counts as empty and is rejected with 400-242.

name

string

length between 1 and 255

New name. Trimmed before the length limit is applied.

isCompetitor

boolean

New competitive flag.

keywords

object

Incremental keyword changes. add and remove may be sent together, but the same keyword
must not appear in both — that comparison is case-insensitive. At least one of the two must
be present and non-empty.

seedUrls

object

Incremental seed-URL changes. add and remove may be sent together, but the same trimmed
URL must not appear in both — that comparison is byte-for-byte, so two URLs differing only
in case are distinct values and do not conflict. At least one of the two must be present
and non-empty.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

429

Too many requests. Reduce concurrency and retry with exponential backoff and jitter. This
response is generated before the request reaches the Intent API, so its body does not use
the Demandbase error envelope.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The complete keyword set as it stands after the update, including both collections in full.

400The path parameter or request body failed validation, or a count limit would be exceeded. When a request has more than one problem, only one error is returned — fix it and resend to see the next. Every check runs before the write, so a rejected request leaves the keyword set untouched.

401Authentication failed, or the token carries no API permissions.

403The token is valid but lacks the INTENT_API_FULL_ACCESS permission these endpoints require.

404The keyword set does not exist, or belongs to another tenant. The two are reported identically so that identifiers cannot be enumerated across tenants.

500An unexpected error occurred. For a write, the change may or may not have been applied, so re-read the keyword set before retrying.

502An upstream service returned an error or an unexpected response. Retry with backoff.

503The service is temporarily unavailable. Retry with backoff.

504The request timed out. A write may still have been applied — re-read the resource before retrying. Requests that add seed URLs are allowed appreciably longer than others, because keyword generation runs synchronously.