Create a Keyword Filter List

You can use keyword filtering to block unwanted messages. Create a list with the keywords you want to use to filter messages, then assign the list to one or more campaigns. Messages containing any of the list keywords will be blocked.

Endpoint

POST /v1/filter-words

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Request Body

name

string

Name of the keyword filter list.

words

array of strings

List of keywords.

Returns

Returns the Keyword Filter List object. This object contains the list name, keywords, and the campaigns that the keyword filter list is associated with.

SAMPLE REQUEST

				
					{
  "name": "Keyword Filters",
  "words": [
    "blocked-word1",
    "blocked-word2",
    "blocked-word3"
  ]
}

SAMPLE RESPONSE

				
					{
  "id": "582df7c3-76da-408e-b1bc-c6bc00414e5b",
  "name": "Keyword Filters",
  "words": [
    "blocked-word1",
    "blocked-word2",
    "blocked-word3"
  ],
  "campaigns": [
    {
      "brandId": "5c068161-206c-4178-b5b1-be4f6e5ce807",
      "brandName": "ABC Mobile",
      "campaignId": "8538e413-b1fe-42c8-b575-4f1f3735811f",
      "campaignName": "Spring Campaign"
    }
  ]
}