Create a keyword set

post

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

Creates a keyword set for your tenant together with its initial keywords and optional seed
URLs.

name and keywords are required. keywords may be an empty array — a set is allowed to
start empty — but the property itself must be present. Keywords are trimmed and then
de-duplicated case-insensitively, so the created set may hold fewer keywords than were
submitted.

Unrecognized properties, and the read-only properties id, createdAt and updatedAt,
are ignored rather than rejected, so a keyword set read from this API can be sent straight
back into a create call.

Requests containing seedUrls trigger synchronous keyword generation and take
considerably longer. Generated keywords are not counted against the per-set keyword limit
at create time, so the new set can hold up to 100 keywords more than that limit. No credits
are deducted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body for creating a keyword set. Unrecognized and read-only properties are ignored rather
than rejected.

name

string

required

length between 1 and 255

Keyword-set name, unique per tenant. Trimmed before the length limit is applied, so a
value that is empty or all whitespace is rejected with 400-244.

isCompetitor

boolean

Defaults to false

Marks the set as competitive. Optional, defaulting to false. A non-boolean value is
rejected with 400-247.

keywords

array of objects

required

Initial keywords. Required, but may be an empty array. Trimmed, then de-duplicated
case-insensitively with the first occurrence winning. Supplying seedUrls may add
further keywords automatically.

keywords*

seedUrls

array of objects

Seed URLs to attach. Optional, defaulting to empty. All new URLs are analysed in one
synchronous call that may add up to 100 generated keywords in total for the request.

seedUrls

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

201The created keyword set. keywords and seedUrls are always present and may be empty.

400The 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. Nothing is written when a request is rejected.

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

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

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.