Spam Listing

  • Published on Aug 6, 2025
  • 1 minute(s) read
  • EM
 Prev Next
Post
/users/block

This API adds users to a spam list, blocking selected communication channels and allowing external systems to manage user blocking more efficiently.

Request Body params:
• Identifiers (required): A valid phone number (including country code) or an email address.
• Channel IDs (optional): A comma-separated list of channel IDs to block.
• Module ID (optional): The communication module to block.
Available modules: Email [6], WhatsApp [13], SMS [14], FB messenger [38]

Note:
• If the user does not exist in the system, a new user profile will be created and added to the spam list.
• You can block all communication channels by providing only the Identifiers parameter.
• To limit blocking to specific channels or modules, include the relevant Channel IDs or Module ID.
• Blocking a module will apply to all channels within that module.
• Blocking a user from a specific sub-channel is not supported.

Security
HTTP
Type bearer

API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.

Body parameters
object
identifiers
string

A valid identifier of user: A phone number or an email address

Example[john.doe1010@gmail.com]
channelIds
string

(optional) Channel IDs can be separated by commas

Example[1514,312]
moduleIds
string

(optional) Type of communication (see Enums)

Example[6]
Responses
200

OK

Expand All
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2025-08-06T07:51:52.2581942Z
data
object
400

Bad Request - The request could not be understood by the server. Incoming parameters might not be valid

object
status
integer
Example400
description
string
ExampleBad Request
response_time
string (date-time)
401

Unauthorized - The supplied credentials, if any, are not sufficient to access the resource

object
status
integer
Example401
description
string
ExampleUnauthorized access
response_time
string (date-time)
404

Not Found - The requested resource is not found

object
status
integer
Example404
description
string
ExampleNot found
response_time
string (date-time)
429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

object
status
integer
Example429
description
string
ExampleToo Many Requests
response_time
string (date-time)
500

Internal Server Error - The server could not return the representation due to an internal server error

{
  "status": 500,
  "description": "Operation failed",
  "response_time": "2025-04-15T07:24:52.956Z"
}
object
status
integer
Example500
description
string
ExampleOperation failed
response_time
string (date-time)
501

Not Implemented - The requested operation is not supported