Contact tools

Additional endpoints provide an overview of the contact register and manage labels, blocked numbers and bulk deletion.

Contact summary

Method	Path
GET	/v2/contacts/meta

curl "https://api.ip1sms.com/v2/contacts/meta" \
  -H "Authorization: Bearer $IP1_TOKEN"

{
  "totalCount": 10,
  "labels": [
    { "labelName": "all", "usageCount": 10 },
    { "labelName": "Customers", "usageCount": 7 }
  ],
  "properties": [
    {
      "propertyName": "phoneNumber",
      "usageCount": 10,
      "averageLength": 11,
      "maxLength": 11,
      "minLength": 11
    }
  ]
}

labels summarizes usage by label. properties contains propertyName, usageCount, averageLength, maxLength and minLength.

Labels

Method	Path	Description
POST	/v2/labels/{labelName}/contacts	Apply the label to multiple contacts.
DELETE	/v2/labels/{labelName}	Remove the label from all contacts. The contacts are retained.

curl -X POST "https://api.ip1sms.com/v2/labels/Customers/contacts" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Content-Type: application/json" \
  -d '["contact_abc123", "contact_def456"]'

The response summarizes the label:

{
  "labelName": "Customers",
  "usageCount": 2
}

Blocklist

The account has a blocklist for numbers that must not receive SMS messages. A number can be added through the API, a STOP reply or the unsubscribe feature.

Method	Path	Description
GET	/blacklist	List blocked numbers.
POST	/blacklist	Add an entry.
GET	/blacklist/{msisdn}	Read an entry.
PUT	/blacklist/{msisdn}	Add or update an entry.
DELETE	/blacklist/{msisdn}	Remove an entry.

The blocklist endpoints belong to an older API structure that remains operational and sit directly under https://api.ip1sms.com, without /v2.

{
  "msisdn": "46700000000",
  "created": "2026-10-05T08:03:21Z"
}

Do not remove a block without a documented reason. The blocklist may form part of the organization’s handling of a recipient’s withdrawn consent.

Bulk deletion

Method	Path
DELETE	/v2/contacts

The same filters used when listing contacts can be used:

curl -X DELETE \
  "https://api.ip1sms.com/v2/contacts?labels=Customers&metadata%5BphoneNumber.isBlocked%5D=true" \
  -H "Authorization: Bearer $IP1_TOKEN"

A request without filters may delete every contact. Add a safeguard to the client, show the match count before execution and require explicit confirmation.

The published response is a collection of the deleted contact documents.