Skip to main content

​
Prerequisites

  • Active cloakup subscription with API keys enabled on your plan
  • An API key with at least campaigns:list (or the scopes you need)
Create keys in the dashboard: app.cloakup.me → Settings → API Keys.

​
Authenticate

Every /v1 request requires:
Keys start with ck_ followed by 64 hex characters.

​
First request

1

List campaigns

2

Check the response

A 200 response includes count and data (array of campaigns). See Errors if you get 401, 403, or 429.
3

Create a domain (if needed)

4

Verify the domain

Repeat until verified: true.
5

Create a campaign

Use the minimal production-safe body. Do not set filters.deny_always: true unless you are testing.

​
Anti-patterns

Avoid these common mistakes — they cause 422 errors or broken production traffic.
  • Do not set filters.deny_always: true unless you explicitly want review/test mode
  • Do not copy the full filters object from a GET response into POST/PUT
  • Do not invent country codes or browser languages — follow Campaign filters
  • Do not send filters.query.params values as a plain string — always string[] (e.g. "utm_source": ["google"])
  • Do not put http(s)://, www, or / in domain name
  • Do not treat PUT as partial PATCH — send a full campaign body
  • Do not use https://api.example.com — use https://api.cloakup.me

​
Environment variables

​
Next steps

Scopes

Which permission each endpoint needs.

Campaign create

Defaults, business rules, and minimal example.

MCP integration

Use Cloakup from Cursor or other MCP clients.

Help center

Dashboard guide for creating and managing keys.