API Reference
Complete reference for all ClickyID API endpoints
https://clickyid.com/api/v1All API requests require authentication using an API key. Include your API key in the Authorization header:
Authorization: Bearer ck_live_your_api_key_here/validate/target-groupValidate an email address against a specific target group to check if it matches the targeting criteria.
Request Body
Loading syntax highlighting...Response
Loading syntax highlighting...Required Scope
validate:target-groups/validate/offerValidate an email address against an offer by checking all associated target groups.
Request Body
Loading syntax highlighting...Response
Loading syntax highlighting...Required Scope
validate:offers/validate/bulkValidate multiple email addresses against target groups or offers in a single request.
Request Body
Loading syntax highlighting...Parameters
Array of email addresses to validate (max 100)
Validation mode: “any” (match any target) or “all” (match all targets)
Array of target group IDs (optional)
Array of offer IDs (optional)
Required Scopes
/target-groupsGet a list of available target groups for your team.
Response
Loading syntax highlighting...Required Scope
validate:target-groups/offersGet a list of available offers for your team.
Response
Loading syntax highlighting...Required Scope
validate:offersUnauthorized
Invalid or missing API key
Forbidden
Insufficient permissions for the requested scope
Rate Limited
Too many requests, check your rate limits
Bad Request
Invalid request format or missing required fields