Skip to Content
APIProject keywords

Project keywords

Project keywords configure what the project matches on Reddit.

Use the project’s id as {projectId} and the keyword’s id as {keywordId}. Keyword IDs are returned by list, create and update operations.

List keywords

List the project’s keywords, ordered by descending id. Each row carries the stable id used by the read, update and delete operations below.

The response is an unpaginated {results} collection. enabled is provider-observed state (null means never observed).

GET/api/v1/projects/{projectId}/keywords/

Responses

200OKapplication/json

FieldTypeRequiredNotes
resultsobject[]yes
idstringyesStable membership UUID (never the shared canonical keyword id).
valuestringyesNormalized keyword value (trimmed, lowercased, whitespace collapsed).
targetstringyesMatching surface for this membership. — one of: "post", "comment", "post_comment"
match_typestringyesMatching mode for this membership. — one of: "all_words", "exact"
enabledboolean | nullyesRead-only provider-observed enabled state (null = never observed); never accepted on write.
{ "results": [ { "id": "3c2b1a0d-1111-4e5f-8a9b-0c1d2e3f4a5b", "value": "notion template", "target": "post", "match_type": "exact", "enabled": true } ] }

All errors answer the standard problem body — this operation can also return 401, 404, 429, 5xx, documented in Errors & retries.

Create keyword

Add one keyword. The value is normalized before storing: trimmed, lowercased, internal whitespace collapsed.

export INTENTLOOM_API_TOKEN='il_live_REPLACE_WITH_YOUR_TOKEN' export INTENTLOOM_PROJECT='b1a2c3d4-0000-4a5b-8c6d-7e8f9a0b1c2d' # "Notion Template" is stored normalized as "notion template"; # target/match_type default to post/all_words. curl -fsS -X POST "https://api.intentloom.com/api/v1/projects/$INTENTLOOM_PROJECT/keywords/" \ -H "Authorization: Token $INTENTLOOM_API_TOKEN" \ -H 'Content-Type: application/json' \ -d '{"value":"Notion Template"}'

Omit target/match_type (or send JSON null) to take the defaults (post, all_words). A 201 returns the stored keyword.

POST/api/v1/projects/{projectId}/keywords/

Request body

Content-Type: application/json — unknown keys are rejected.

FieldTypeRequiredNotes
valuestringyesKeyword phrase (1-200 chars after trim; lowercased, internal whitespace collapsed). — 1–200 chars
targetstring | nullnoMatching surface; defaults to post. null means the default. — one of: "post", "comment", "post_comment"
match_typestring | nullnoMatching mode; defaults to all_words. null means the default. — one of: "all_words", "exact"
{ "value": "Notion Template", "target": "post", "match_type": "exact" }

Responses

201Createdapplication/json

FieldTypeRequiredNotes
idstringyesStable membership UUID (never the shared canonical keyword id).
valuestringyesNormalized keyword value (trimmed, lowercased, whitespace collapsed).
targetstringyesMatching surface for this membership. — one of: "post", "comment", "post_comment"
match_typestringyesMatching mode for this membership. — one of: "all_words", "exact"
enabledboolean | nullyesRead-only provider-observed enabled state (null = never observed); never accepted on write.
{ "id": "3c2b1a0d-1111-4e5f-8a9b-0c1d2e3f4a5b", "value": "notion template", "target": "post", "match_type": "exact", "enabled": true }

409Conflict

The requested keyword identity duplicates or overlaps an existing membership in the same collection.

All errors answer the standard problem body — this operation can also return 400, 401, 403, 404, 429, 5xx, documented in Errors & retries.

A value that duplicates or overlaps an existing keyword answers 409 with no mutation — reconcile by listing, not by replaying the POST (errors & retries).

Get keyword

Read one project keyword by its stable id.

GET/api/v1/projects/{projectId}/keywords/{keywordId}/

Responses

200OKapplication/json

FieldTypeRequiredNotes
idstringyesStable membership UUID (never the shared canonical keyword id).
valuestringyesNormalized keyword value (trimmed, lowercased, whitespace collapsed).
targetstringyesMatching surface for this membership. — one of: "post", "comment", "post_comment"
match_typestringyesMatching mode for this membership. — one of: "all_words", "exact"
enabledboolean | nullyesRead-only provider-observed enabled state (null = never observed); never accepted on write.
{ "id": "3c2b1a0d-1111-4e5f-8a9b-0c1d2e3f4a5b", "value": "notion template", "target": "post", "match_type": "exact", "enabled": true }

All errors answer the standard problem body — this operation can also return 401, 404, 429, 5xx, documented in Errors & retries.

Update keyword

Update one keyword. Send any nonempty subset of the writable fields; omitted fields stay unchanged and the keyword’s id never changes.

The update is narrow by design: JSON nulls, unknown keys and the read-only enabled field are rejected with 400.

PATCH/api/v1/projects/{projectId}/keywords/{keywordId}/

Request body

Content-Type: application/json — unknown keys are rejected.

FieldTypeRequiredNotes
valuestringno1–200 chars
targetstringnoone of: "post", "comment", "post_comment"
match_typestringnoone of: "all_words", "exact"
{ "match_type": "all_words" }

Responses

200OKapplication/json

FieldTypeRequiredNotes
idstringyesStable membership UUID (never the shared canonical keyword id).
valuestringyesNormalized keyword value (trimmed, lowercased, whitespace collapsed).
targetstringyesMatching surface for this membership. — one of: "post", "comment", "post_comment"
match_typestringyesMatching mode for this membership. — one of: "all_words", "exact"
enabledboolean | nullyesRead-only provider-observed enabled state (null = never observed); never accepted on write.
{ "id": "3c2b1a0d-1111-4e5f-8a9b-0c1d2e3f4a5b", "value": "notion template", "target": "post", "match_type": "all_words", "enabled": true }

409Conflict

The requested keyword identity duplicates or overlaps an existing membership in the same collection.

All errors answer the standard problem body — this operation can also return 400, 401, 403, 404, 429, 5xx, documented in Errors & retries.

A PATCH whose result is identical to the stored row is a 200 no-op.

Delete keyword

Remove one keyword. Its id stops being valid; nothing is reseeded.

DELETE/api/v1/projects/{projectId}/keywords/{keywordId}/

Responses

204No Contentno body

All errors answer the standard problem body — this operation can also return 401, 403, 404, 429, 5xx, documented in Errors & retries.

Success is 204 with no body. Deleting the same id again returns 404 — treat that as success for your end state (errors & retries).

Last updated on