Endpoints for authenticating against the KlickTipp API and managing API access. These operations are used to establish and terminate authenticated sessions or to validate credentials required for protected API requests.
KlickTipp API (0.0.0)
This specification describes the KlickTipp Management API.
It is intended for developers and integrators who want to interact directly with KlickTipp to manage contacts, tags, custom fields, opt-in processes, and automation workflows.
The API can be used standalone or through third-party platforms.
The specification focuses on correct request formats, authentication mechanisms, response structures, and error handling to ensure reliable and predictable integrations.
Good to know: This API uses session-based cookie authentication. Interactive Try-It requests do not fully support this login flow. For production testing click on the button to open our Collection in Postman.
The base URL for the KlickTipp API production environment is:
https://api.klicktipp.comAll endpoints defined in this specification are relative to this base URL.
To access the API, you must authenticate and maintain a valid session.
Authentication
Most endpoints require cookie-based authentication.
Use the login endpoint with your KlickTipp username and password to obtain a session cookie, which must be sent with all subsequent requests.Request Preparation
Replace all placeholder values such as email addresses, IDs, or timestamps with valid test data.
Invalid formats are a common source of errors.Response Handling
The API returns structured payloads and numeric error codes.
Always validate HTTP status codes and response bodies programmatically.
The KlickTipp Management API supports multiple authentication models, depending on the integration scenario.
Username and password authentication via session cookie
Typically used for internal tools and administrative workflows.Developer key and customer key authentication
Intended for long-running, production-grade, or multi-tenant integrations.
This model does not rely on session handling.
Documentation:
How to authenticate and access the Management API
The KlickTipp Management API uses JSON as its response format.
All endpoints return JSON responses, including structured data, timestamps, and error details.
Integrations are expected to consume and validate JSON exclusively.
Date and time values must always be provided as Unix timestamps (seconds).
Formatted date strings, locale-specific formats, and timezone annotations are not supported.
Incorrect field formats are a frequent cause of validation errors. Always ensure that submitted values match the expected field type definitions.
Documentation:
Data field types and Inputs
Errors are typically returned with HTTP status code 406 and include a numeric error code in the response body.
Integrations should handle errors explicitly and provide meaningful diagnostics for debugging and monitoring.
Documentation:
Error Handling
This specification is designed to support stable, predictable, and maintainable integrations with the KlickTipp platform.
Download OpenAPI description
Languages
Servers
KlickTipp REST API
https://api.klicktipp.com
- KlickTipp REST APIhttps://api.klicktipp.com/subscriber/tag
- curl
- Node.js
- Java
- Python
- PHP
curl -i -X POST \
https://api.klicktipp.com/subscriber/tag \
-H 'Content-Type: application/json' \
-d '{
"email": "alex.example@klicktipp.example",
"tagids": [
"17",
"18"
]
}'- KlickTipp REST APIhttps://api.klicktipp.com/subscriber/untag
- curl
- Node.js
- Java
- Python
- PHP
curl -i -X POST \
https://api.klicktipp.com/subscriber/untag \
-H 'Content-Type: application/json' \
-d '{
"email": "alex.example@klicktipp.example",
"tagid": "17"
}'