ApexDevelopers

Keywords

Manage keyword-based engagement rules for automated replies.

GET
/keyword

List all keyword rules

Response

200Array of keyword rules

List all keyword rules:

POST
/keyword

Create a new keyword rule

Request Body

NameTypeRequiredDescription
filter
object
Required
Keyword filter configuration
filter.includeWords
string[]
Optional
Words that must appear in tweets
filter.excludeWords
string[]
Optional
Words to exclude
filter.minLikes
number
Optional
Minimum like count
filter.minReplies
number
Optional
Minimum reply count
filter.fromUsers
string[]
Optional
Only match tweets from these users
tone
string
Optional
Engagement tone for replies
replyRateOptions
object
Optional
Rate limiting options

Success Response

Returns the created keyword object.

Error Response

409Duplicate rule

Create a keyword rule with filter:

DELETE
/keyword/:id

Delete a keyword rule

Path Parameters

NameTypeRequiredDescription
id
string
Required
The keyword rule ID

Error Response

404Not found

Delete a keyword rule by ID: