Skip to main content
POST
/
v1.0
/
subscribers
/
message-filter
/
update
json
{
  "FilterId": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1",
  "FilterMode": "MONITOR_ONLY",
  "AllowedContacts": ["+1111111111"],
  "BlockedContacts": ["+3333333333"]
}
{
  "FilterId": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1",
  "SubscriberId": "SID-A1AB23C0-....-....-....-EBE284131441",
  "Phone": "+1234567890",
  "FilterMode": "MONITOR_ONLY",
  "AllowedContacts": [
    "+1111111111",
    "+2222222222"
  ],
  "BlockedContacts": [
    "+3333333333"
  ],
  "KeywordFilter": "\"CustomKeywords\":[\"inappropriate\",\"banned\"],\"SystemKeywords\":{\"Profanity\":[\"word1\",\"word2\"],\"Violence\":[\"threat1\"]},\"SeverityMap\":{\"Word1\":\"HIGH\",\"Inappropriate\":\"MEDIUM\"}",
  "NotificationPhones": [
    "+9999999999"
  ],
  "ApplyToOutbound": true,
  "ApplyToInbound": true,
  "BlockUnknownNumbers": true,
  "BlockLinks": true,
  "BlockMedia": true
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
FilterId
string
required

Message Filter ID to update

Example:

"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1"

​
SubscriberId
string

Subscriber ID

​
Phone
string

Phone number (E.164 format)

​
FilterMode
enum<string>

Filter mode

Available options:
ACTIVE,
MONITOR_ONLY,
INACTIVE
​
AllowedContacts
string[]

List of allowed contact phone numbers

​
BlockedContacts
string[]

List of blocked contact phone numbers

​
KeywordFilter
string

JSON string containing keyword filter configuration

​
NotificationPhones
string[]

Phone numbers to receive filter notifications

​
ApplyToOutbound
boolean

Apply filter to outbound messages

​
ApplyToInbound
boolean

Apply filter to inbound messages

​
BlockUnknownNumbers
boolean

Block messages from unknown numbers

​
BlockLinks
boolean

Block messages containing links

​
BlockMedia
boolean

Block messages containing media

Response

200 - application/json

Message Filter Updated

The response is of type object.