CAN-SPAM API

Get CAN-SPAM information by IP Address

Returns CAN-SPAM information based on the IP address passed as a query parameter.

When the IP address is geolocated to the United States or Hong Kong, the response will indicate whether the user can be contacted through marketing communications.

Parameters

Name Description
token The authorization token
ip_address The ip address to determine if consent is required

Response Fields

Name Description
country Geolocated country code
consent_required If the user required consent to be contacted via marketing communications

Request

Headers

Accept: application/json

Route

GET /api/v1/canspam/ip?token=[your_auth_token]&ip_address=72.229.28.185

Query Parameters

token=[your_auth_token]
ip_address=72.229.28.185

Response

Headers

Content-Type: application/json

Status

200

Body