Create Blacklist

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 to tpl-blk002001.
If countryCode is omitted, it defaults to PH.

Supported Template

Template ID	Region	Required Parameters
`tpl-blk002001`	PH (default)	`consent`, `mobileNumber`, `countryCode`, `templateId`

Field Rules

templateId is optional; if missing, the system uses tpl-blk002001.
countryCode is also optional; if omitted, it defaults to PH.

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mobileNumber

string

required

Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros

countryCode

string | null

enum

2 character alpha ISO-3166 codes

templateId

string

Defaults to blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e

Generated internally by Smile. Customers should request the specific templateId from Smile. If this value is null, Smile will use the default value blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e.

applicationDate

date

Smile will query the data that before this date. The format is yyyy-MM-dd.

consent

object

required

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK