Blacklist

Create an entry in blacklist

post/v4/blacklist

Request

  • Base URL: https://api.inmobile.com
  • URL: https://api.inmobile.com/v4/blacklist
  • Auth: one of:
    • HTTP basic
    • API key in query parameter apikey

Request body

commentstring

A comment describing the specific blacklisting.

removeFromAllListsboolean nullable

If true, the number will also be removed from all lists. Default: false

Example request

{
  "numberInfo": {
    "countryCode": "45",
    "phoneNumber": "12345678"
  },
  "comment": "Some text provided when created"
}

Response

The created blacklist

commentstring

A comment describing the specific blacklisting.

idstring guid

The id of the blacklist entry

createdstring

When the blacklist entry was created e.g. 2001-02-30T14:50:23Z (UTC time)

reasonCode1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

1 = CustomerSpecificUnsubscription 2 = SharedUnsubscription 3 = CountryBanLaw 4 = AddWithUserInterface 5 = AddFromApi 6 = Custom 7 = AddFromCrm 8 = RecipientSyncRemoval 9 = Autoblacklist 10 = SpamLimit 11 = UnsubscribeForm 12 = CustomDomain 13 = Rcs 14 = WhatsApp

reasonCodeDescriptionstring

Text version of the ReasonCode

Example response

{
  "numberInfo": {
    "countryCode": "45",
    "phoneNumber": "12345678"
  },
  "comment": "Some text provided when created",
  "id": "683862c7-c814-40cc-a74d-048d9f2f8cb7",
  "created": "2001-02-30T14:50:23Z",
  "reasonCodeDescription": "AddFromApi"
}

Changes

No recorded changes to this operation across all 1 revision of this API.