Blocklist API

Block specific phone numbers from reaching your tracking numbers. Blocked callers are rejected before the call connects. Manage blocklists per company, partner, or group.

The Blocklist API requires BlocklistPermission on your account token. Contact support@logimeter.com if you need this enabled.

List Blocklist

GET /v1/blocklist/ Retrieve the current blocklist for your account

Token Auth v1

Returns all blocked phone numbers grouped by entity context.

Response Fields

Field	Type	Description
id	integer	Blocklist record ID.
entity_context_name	string	Scope of the block: "company", "partner", or "group".
entity	object	Entity details including name and reference.
blocked_phone_number_list	array	Array of blocked number objects, each with a `phone_number` field.

Block Numbers

POST /v1/blocklist/ Add phone numbers to the blocklist

Token Auth v1

Add one or more phone numbers to the blocklist for the specified entity. Numbers already on the list are ignored (not duplicated).

Request Fields

Field	Type	Required	Description
entity	object	required	The partner company, partner, or group to apply the block to. Contains `reference` and `name`.
entity_context_name	string	optional	Scope: `"company"`, `"partner"`, or `"group"`. Defaults to `"partner"`.
blocked_phone_number_list	array	required	Array of objects, each with a `phone_number` field (E.164, no + prefix).

Example

Block two numbers for a company

curl -X POST https://next.logimeter.com/v1/blocklist/ \
  -H "Authorization: Token YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entity": {
      "reference": "dealer-cape-town-001",
      "name": "Cape Town Dealer"
    },
    "entity_context_name": "company",
    "blocked_phone_number_list": [
      {"phone_number": "27831234567"},
      {"phone_number": "27114567890"}
    ]
  }'

Responses

201 Created

Numbers were added to the blocklist. Response contains the updated blocklist record.

{
  "id": 42,
  "entity_context_name": "company",
  "entity": {
    "reference": "dealer-cape-town-001",
    "name": "Cape Town Dealer"
  },
  "blocked_phone_number_list": [
    {"phone_number": "27831234567"},
    {"phone_number": "27114567890"}
  ]
}

400 Bad Request

The request body is missing required fields or contains invalid phone numbers.

403 Forbidden

Your token does not have BlocklistPermission.

Unblock Numbers

POST /v1/blocklist/unblock/ Remove specific numbers from the blocklist

Token Auth v1

Removes the specified numbers from the blocklist for the given entity. Uses the same request structure as POST /v1/blocklist/ — the numbers listed in blocked_phone_number_list are removed instead of added.

Example

Unblock a single number

curl -X POST https://next.logimeter.com/v1/blocklist/unblock/ \
  -H "Authorization: Token YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entity": {
      "reference": "dealer-cape-town-001",
      "name": "Cape Town Dealer"
    },
    "entity_context_name": "company",
    "blocked_phone_number_list": [
      {"phone_number": "27831234567"}
    ]
  }'

Responses

200 OK

The specified numbers were removed from the blocklist.

404 Not Found

One or more of the specified numbers were not found on the blocklist for this entity.