Skip to content
/
Get Opt-in Process

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.

Base URL

The base URL for the KlickTipp API production environment is:

  https://api.klicktipp.com

All endpoints defined in this specification are relative to this base URL.

Getting Started

To access the API, you must authenticate and maintain a valid session.

  1. 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.

  2. 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.

  3. Response Handling
    The API returns structured payloads and numeric error codes.
    Always validate HTTP status codes and response bodies programmatically.

Authentication Overview

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

Response Format

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.

Data Formats and Validation

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

Error Handling

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
management-api.json
management-api.yaml
Languages
Servers
KlickTipp REST API
https://api.klicktipp.com

Authentication

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.

Operations

Contacts

Endpoints for creating, updating, and retrieving subscriber data in KlickTipp. These operations allow external systems to manage contact records, including core profile information and custom data fields.

Operations

Contact Tagging

Endpoints for assigning and removing tags from subscribers. Tagging operations are used to control automations, trigger workflows, and reflect changes in subscriber state based on external events.

Operations

Data Fields

Endpoints for managing custom data fields associated with subscribers. These operations are used to define, retrieve, and map structured subscriber data for personalization and integration purposes.

Operations

Opt-In Processes

Endpoints related to opt-in workflows and subscription confirmation processes. These operations support compliant subscriber onboarding, including single and double opt-in flows.

Operations

List Opt-in Processes

Request

Lists the IDs and names of all opt-in processes.

Notice: The Id without a name is the Default Double Opt-In present in each KlickTipp Account.

curl -i -X GET \
  https://api.klicktipp.com/list

Responses

Success Response.

Bodyapplication/json
property name*stringadditional property
Response
application/json
{
  "3": "",
  "23": "my-optin-process"
}

Get Opt-in Process

Request

Returns the complete data of an opt-in process.

Path
listidstring\d+required
curl -i -X GET \
  'https://api.klicktipp.com/list/{listid}'

Responses

Success Response.

Bodyapplication/json
listidinteger

The list id

Example: 16
namestring

The list name

Example: "my optin process"
usesingleoptinboolean

Use single opt-in

Example: false
pendingurlstring

Pending url

Example: "https://mypending.com"
thankyouurlstring

Thank you url

Example: "https://mythankyou.com"
resendconfirmationemailboolean

Resend confirmation email

Example: false
usechangeemailboolean

Use change email

Example: false
Response
application/json
{
  "listid": 16,
  "name": "my optin process",
  "usesingleoptin": false,
  "pendingurl": "https://mypending.com",
  "thankyouurl": "https://mythankyou.com",
  "resendconfirmationemail": false,
  "usechangeemail": false
}

Search Redirect URL

Request

Search the redirection URL for a specific opt-in process.

Body
required
listidstringrequired

OptIn-Process ID.

Example: "45"
emailstringrequired

Contact email.

Example: "hello@example.com"
curl -i -X POST \
  https://api.klicktipp.com/list/redirect \
  -H 'Content-Type: application/json' \
  -d '{
    "listid": "45",
    "email": "hello@example.com"
  }'

Responses

Success Response.

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "https://mypendingurl.com"
]

Tags

Endpoints for managing and querying available tags in KlickTipp. These operations allow systems to retrieve tag metadata and understand which tags can be used for segmentation and automation control.

Operations
© 2026 KlickTipp. All rights reserved.