post https://sandbox.smileapi.io/v1/alpha/blacklists
Create a Blacklist object.
This endpoint requires the following input parameters:
consent
, mobileNumber
, templateId
, and countryCode
.
Default Behavior
- If
templateId
is not provided, it defaults totpl-blk002001
. - If
countryCode
is omitted, it defaults toPH
.
Supported Template
Template ID | Region | Required Parameters |
---|---|---|
tpl-blk002001 | PH (default) | consent , mobileNumber , countryCode , templateId |
Field Rules
templateId
is optional; if missing, the system usestpl-blk002001
.countryCode
is also optional; if omitted, it defaults toPH
.
Sandbox Test Values
Parameter | Value | Expected Response |
---|---|---|
mobileNumber | 639559991234 | |
countryCode | PH | resultCode = SUCCESS , hit = true |
For all other valid mobile number and country code combinations, the response will return:
resultCode = SUCCESS
, but hit = false
.