# KlickTipp

> Manage contacts, tags and opt-in processes with KlickTipp’s Management API.

App · 22 actions. Web page: https://docs.lodol.com/docs/integrations/klicktipp

## Actions

### Create tag

Create Tag.

**Inputs**

- Name (`name`, text, required): Name of the tag
- Text (`text`, text): Descriptive text for the tag

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Delete contact

Delete Contact.

**Inputs**

- Subscriberid (`subscriberid`, text, required): The identifier of the contact. This can be either: - **Internal Subscriber ID** (Contact ID) Recommended for internal, server-side integrations. Numeric string, for example `987654321`. - **External Subscriber Key** (Contact Key) Recommended for external communication such as email links, redirect URLs and form integrations. Alphanumeric string, for example `01234abcdefghij56789`. Both identifiers can be used interchangeably in this endpoint.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Delete tag

Delete Tag.

**Inputs**

- Tagid (`tagid`, number, required): Internal ID of the tag

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Get contact

Get Contact.

**Inputs**

- Subscriberid (`subscriberid`, text, required): The identifier of the contact. This can be either: - **Internal Subscriber ID** (Contact ID) Recommended for internal, server-side integrations. Numeric string, for example `987654321`. - **External Subscriber Key** (Contact Key) Recommended for external communication such as email links, redirect URLs and form integrations. Alphanumeric string, for example `01234abcdefghij56789`. Both identifiers can be used interchangeably in this endpoint.

**Outputs**

- `data` (object): Legacy subscriber detail representation. Field formats and semantics are not fully normalized.

**Example output**

```json
{
  "data": {
    "bounce": "example",
    "campaigns_finished": {},
    "campaigns_started": {},
    "date": "example",
    "email": "example",
    "emails_clicked": {},
    "emails_opened": {},
    "emails_sent": {},
    "fieldBirthday": "example",
    "fieldCity": "example",
    "fieldCompanyName": "example",
    "fieldCountry": "example",
    "fieldFax": "example",
    "fieldFirstName": "example",
    "fieldLastName": "example",
    "fieldLeadValue": "example",
    "fieldMobilePhone": "example",
    "fieldPhone": "example",
    "fieldPrivatePhone": "example",
    "fieldState": "example",
    "fieldStreet1": "example",
    "fieldStreet2": "example",
    "fieldWebsite": "example",
    "fieldZip": "example",
    "id": "example",
    "ip": "example",
    "listid": "example",
    "manual_tags": {},
    "notification_emails_clicked": {},
    "notification_emails_opened": {},
    "notification_emails_sent": {},
    "optin": "example",
    "optin_ip": "example",
    "referrer": "example",
    "smart_tags": {},
    "sms_bounce": "example",
    "sms_date": "example",
    "sms_phone": "example",
    "sms_referrer": "example",
    "sms_status": "example",
    "sms_unsubscription": "example",
    "status": "example",
    "tags": [],
    "unsubscription": "example",
    "unsubscription_ip": "example"
  }
}
```

### Get contacts

Get Multiple Contacts.

**Inputs**

- Subscriberids (`subscriberids`, list, required): Subscriberids.

**Outputs**

- `data` (object): Contact details keyed by the requested subscriber ID; missing contacts are null.

**Example output**

```json
{
  "data": {}
}
```

### Get field

Get Data Field.

**Inputs**

- Fieldid (`fieldid`, text, required): Unprefixed data field ID (for `field12345`, pass `12345`)
- Detail (`detail`, true/false): Include the field type, dimensionality, AI description, category name, and meta-label names. Default: `false`.

**Outputs**

- `data` (object): Compact response (default or detail=false).

**Example output**

```json
{
  "data": {
    "id": 1,
    "name": "example"
  }
}
```

### Get opt in process

Get Opt-in Process.

**Inputs**

- Listid (`listid`, number, required): Internal ID of the opt-in process

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "listid": 1,
    "name": "example",
    "pendingurl": "example",
    "resendconfirmationemail": false,
    "thankyouurl": "example",
    "usechangeemail": false,
    "usesingleoptin": false
  }
}
```

### Get tag

Get Tag.

**Inputs**

- Tagid (`tagid`, number, required): Internal ID of the tag

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "name": "example",
    "tagid": "example",
    "text": "example"
  }
}
```

### List changed contacts

List Changed Contacts (Paginated).

**Inputs**

- Changed since (`from_value`, date and time): Unix timestamp in seconds. Changes at this timestamp are included. At least 0. Default: `0`.
- Cursor (`cursor`, text): Opaque cursor returned as nextCursor by the previous page.
- Limit (`limit`, number): Maximum number of contact IDs to return. From 1 to 200. Default: `100`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "subscriberIds": []
  }
}
```

### List contacts

List Contacts.

**Inputs**

- Status (`status`, list): Filter contacts by their subscription status (subscribed, pending, unsubscribed). If no value is selected, the filter defaults to subscribed, meaning only contacts with an active subscription are included. One or more of: `subscribed`, `pending`, `unsubscribed`. Default: `["subscribed"]`.
- Bounce status (`bounce_status`, list): Filter contacts by their bounce status (hardbounce, softbounce, spambounce, nobounce). If no value is selected, the filter defaults to softbounce, spambounce, and nobounce. One or more of: `hardbounce`, `softbounce`, `spambounce`, `nobounce`. Default: `["softbounce", "spambounce", "nobounce"]`.
- Limit (`limit`, number): Maximum number of contact IDs to return. If omitted, all matching contact IDs are returned (legacy behavior). If given, enables pagination and the value is capped to 500. From 1 to 500.
- Cursor (`cursor`, text): Opaque pagination cursor, taken unchanged from the previous page's nextCursor. Omit for the first page. Only applied when limit is given.

**Outputs**

- `data` (object): Contact IDs and pagination information.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "subscriberIds": []
  }
}
```

### List fields

List Data Fields.

**Inputs**

- Detail (`detail`, true/false): Return the name and type for each data field. Default: `false`.

**Outputs**

- `data` (object): Compact response (default or detail=false).

**Example output**

```json
{
  "data": {}
}
```

### List opt in processes

List Opt-in Processes.

**Inputs**

- Detail (`detail`, true/false): Return the name, pending URL, and thank-you URL for each opt-in process. Default: `false`.

**Outputs**

- `data` (object): Compact response (default or detail=false).

**Example output**

```json
{
  "data": {}
}
```

### List tags

List Tags.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Search contact

Search Contact ID.

**Inputs**

- Email (`email`, text, required): Email address of the contact

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Search redirect url

Search Redirect URL.

**Inputs**

- Listid (`listid`, text, required): Internal ID of the opt-in process
- Email (`email`, text, required): Email address of the contact

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Search tagged contacts

Search Tagged Contacts.

**Inputs**

- Tagid (`tagid`, number, required): The ID of the tag to which the contacts belong
- Status (`status`, list, required): Filter contacts by their subscription status (subscribed, pending, unsubscribed). If no value is selected, the filter defaults to subscribed, meaning only contacts with an active subscription are included.
- Bounce status (`bounce_status`, list, required): Filter contacts by their bounce status (hardbounce, softbounce, spambounce, nobounce). If no value is selected, the filter defaults to softbounce, spambounce, and nobounce.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Tag contact

Tag Contact.

**Inputs**

- Email (`email`, text, required): Email address of the contact
- Tagids (`tagids`, list, required): Array of tag IDs that are assigned to the contact

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Unsubscribe contact

Unsubscribe Contact.

**Inputs**

- Email (`email`, text, required): Email address of the contact

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Untag contact

Untag Contact.

**Inputs**

- Email (`email`, text, required): Email address of the contact
- Tagid (`tagid`, number, required): Tag ID to remove from the contact

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Update contact

Update Contact.

**Inputs**

- Subscriberid (`subscriberid`, text, required): The identifier of the contact. This can be either: - **Internal Subscriber ID** (Contact ID) Recommended for internal, server-side integrations. Numeric string, for example `987654321`. - **External Subscriber Key** (Contact Key) Recommended for external communication such as email links, redirect URLs and form integrations. Alphanumeric string, for example `01234abcdefghij56789`. Both identifiers can be used interchangeably in this endpoint.
- Newemail (`newemail`, text): Valid email address and must contain `@`. Either `email` or `smsnumber` is required. Email address must be unique per contact.
- Newsmsnumber (`newsmsnumber`, text): Phone number in international format. Either `email` or `smsnumber` is required. SMS number must be unique per contact. Accepted input: - `+4912345678` - `004912345678` Stored format: - `004912345678`
- Fields (`fields`, object): Additional custom fields for the subscriber. Keys must match the field names configured in KlickTipp. Each field expects a specific data format depending on its field type. - `Line`: Single-line text without line breaks. Example: `Alex Example` - `Paragraph`: Text with paragraphs. Use `\n` to separate paragraphs. Example: `Dies ist ein Text.\nMit Absatz.` - `Number`: Integer value. No dot, no comma. Example: `42` - `Decimal Number`: Decimal value. Output always uses a dot as decimal separator. Example: Input `1999` → Output `19.99` - `URL`: Valid web address. Must start with `http://` or `https://`. Example: `https://klicktipp.com` - `Time`: Unix timestamp between `0` and `86399` (seconds since midnight). Example: `52200` (14:30 GMT) - `Date`: Unix timestamp in seconds. Date formats like `DD.MM.YYYY` are not supported. Example: `1715126400` (08.05.2024 GMT) - `Date & Time`: Unix timestamp in seconds. Do not send formatted date strings or values with spaces. Example: `1715603400` (13.05.2024 12:30:00 GMT) - `HTML`: HTML-formatted content. Only use this type if the field explicitly allows HTML. Example: `<strong>Hello World</strong>`

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Update tag

Update Tag.

**Inputs**

- Tagid (`tagid`, number, required): Internal ID of the tag
- Name (`name`, text): Name of the tag
- Text (`text`, text): Descriptive text for the tag

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Upsert contact

Add or Update Contact.

**Inputs**

- Email (`email`, text): Valid email address and must contain `@`. Either `email` or `smsnumber` is required. Email address must be unique per contact.
- Smsnumber (`smsnumber`, text): Phone number in international format. Either `email` or `smsnumber` is required. SMS number must be unique per contact. Accepted input: - `+4912345678` - `004912345678` Stored format: - `004912345678`
- Listid (`listid`, number): Opt-in process ID. If provided, this opt-in process is used. If omitted, the predefined double opt-in process is triggered automatically, which may trigger an email to the contact. Retrieve available opt-in process IDs via `GET /list`.
- Tagid (`tagid`, number): Tag ID assigned to the contact. Used for segmentation and automation triggers. Retrieve available tag IDs via `GET /tag`.
- Fields (`fields`, object): Additional custom fields for the subscriber. Keys must match the field names configured in KlickTipp. Each field expects a specific data format depending on its field type. - `Line`: Single-line text without line breaks. Example: `Alex Example` - `Paragraph`: Text with paragraphs. Use `\n` to separate paragraphs. Example: `Dies ist ein Text.\nMit Absatz.` - `Number`: Integer value. No dot, no comma. Example: `42` - `Decimal Number`: Decimal value. Output always uses a dot as decimal separator. Example: Input `1999` → Output `19.99` - `URL`: Valid web address. Must start with `http://` or `https://`. Example: `https://klicktipp.com` - `Time`: Unix timestamp between `0` and `86399` (seconds since midnight). Example: `52200` (14:30 GMT) - `Date`: Unix timestamp in seconds. Date formats like `DD.MM.YYYY` are not supported. Example: `1715126400` (08.05.2024 GMT) - `Date & Time`: Unix timestamp in seconds. Do not send formatted date strings or values with spaces. Example: `1715603400` (13.05.2024 12:30:00 GMT) - `HTML`: HTML-formatted content. Only use this type if the field explicitly allows HTML. Example: `<strong>Hello World</strong>`

**Outputs**

- `data` (object): Legacy subscriber detail representation. Field formats and semantics are not fully normalized.

**Example output**

```json
{
  "data": {
    "bounce": "example",
    "campaigns_finished": {},
    "campaigns_started": {},
    "date": "example",
    "email": "example",
    "emails_clicked": {},
    "emails_opened": {},
    "emails_sent": {},
    "fieldBirthday": "example",
    "fieldCity": "example",
    "fieldCompanyName": "example",
    "fieldCountry": "example",
    "fieldFax": "example",
    "fieldFirstName": "example",
    "fieldLastName": "example",
    "fieldLeadValue": "example",
    "fieldMobilePhone": "example",
    "fieldPhone": "example",
    "fieldPrivatePhone": "example",
    "fieldState": "example",
    "fieldStreet1": "example",
    "fieldStreet2": "example",
    "fieldWebsite": "example",
    "fieldZip": "example",
    "id": "example",
    "ip": "example",
    "listid": "example",
    "manual_tags": {},
    "notification_emails_clicked": {},
    "notification_emails_opened": {},
    "notification_emails_sent": {},
    "optin": "example",
    "optin_ip": "example",
    "referrer": "example",
    "smart_tags": {},
    "sms_bounce": "example",
    "sms_date": "example",
    "sms_phone": "example",
    "sms_referrer": "example",
    "sms_status": "example",
    "sms_unsubscription": "example",
    "status": "example",
    "tags": [],
    "unsubscription": "example",
    "unsubscription_ip": "example"
  }
}
```
