Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Blacklists (Alpha)

Create Blacklist1

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 IDRegionRequired Parameters
tpl-blk002001PH (default)consent, mobileNumber, countryCode, templateId
blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e (deprecated)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

ParameterValueExpected Response
mobileNumber639559991234
countryCodePHresultCode = SUCCESS, hit = true

For all other valid mobile number and country code combinations, the response will return:
resultCode = SUCCESS, but hit = false.

post/alpha/blacklists

Request body

OR

Example request

{
  "mobileNumber": "639559991234",
  "countryCode": "PH",
  "templateId": "tpl-blk002001",
  "applicationDate": "2023-01-21",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "mobileNumber": "639559991234",
      "countryCode": "PH",
      "templateId": "tpl-blk002001",
      "applicationDate": "2023-01-21",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    },
    "result": {
      "dates": [
        "2000-01-21"
      ]
    }
  }
}