Quick Start

To use the ClickyID API, you need an API key. This key allows you to authenticate your requests and access the API securely.

First, you'll need to create an API key in your team dashboard.

1. Navigate to your team dashboard and click “API keys”
2. Click “Create API key” and give it a descriptive name
3. Select the scopes you need (e.g., validate:offers, validate:target-groups)
4. Copy and securely store your API key

Offer Validation (Recommended)

Test your API key with email validation requests. Start with offer validation (most common) or target group validation. Validate an email against all target groups associated with a specific offer:

Loading syntax highlighting...

Target Group Validation

Validate an email against a specific target group:

Loading syntax highlighting...

Using JavaScript

Loading syntax highlighting...

The API returns enhanced validation information with detailed metadata:

Successful Offer Validation Response

Loading syntax highlighting...

Error Response

Loading syntax highlighting...