{"items":[{"type":"link","label":"KlickTipp Listbuilding API","link":"/listbuilding-api","routeSlug":"/listbuilding-api","content":{"contentType":"overview","meta":{"name":"KlickTipp Listbuilding API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"listbuilding-api.json","url":"/_bundle/listbuilding-api.json?download"},{"kind":"download","label":"listbuilding-api.yaml","url":"/_bundle/listbuilding-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.klicktipp.com/contact/","url":"https://www.klicktipp.com/contact/"},{"kind":"email","title":"KlickTipp Support","email":"hilfe@klicktipp.com","label":"hilfe@klicktipp.com","withCopyButton":true,"copyContent":"hilfe@klicktipp.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"},{"key":"php","title":"PHP","lang":"PHP"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"KlickTipp Listbuilding API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This specification describes the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KlickTipp Listbuilding API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is intended for external tools, websites, and automation platforms that integrate KlickTipp list-building functionality using "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typical use cases include newsletter sign-up forms, lead magnets, landing pages, and no-code or iPaaS-based automations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Listbuilding API provides a restricted and purpose-built interface for managing contacts "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without requiring full account authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Using an API key, external systems can add or update contacts, assign or remove a tag, trigger opt-in processes, or unsubscribe contacts from further communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api"}],"sectionId":"/listbuilding-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication-model"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Model"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints in this specification use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key is generated in KlickTipp under:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listbuilding → New Listbuilding → Entry via API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each API key is permanently linked to a specific opt-in process and tag. This defines the scope and behavior of the integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication is performed by sending the API key "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"directly in the request body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". No session handling or cookies are required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.klicktipp.com/guides/listbuilding-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to Create an API Key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/authentication-model"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/intended-usage"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intended Usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is optimized for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External signup and opt-in forms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded integrations in websites such as WordPress or landing page builders"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated lead processing via third-party platforms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not intended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for administrative workflows or full account management."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/intended-usage"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/core-endpoints"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Core Endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Listbuilding API focuses on a small, stable set of endpoints designed for external systems:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signin"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a contact and associates the tag linked to the API key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signout"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes the tag of a contact associated with the API key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signoff"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribes a contact via the API key and prevents further communication"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/core-endpoints"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/base-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base URL for the KlickTipp API production environment is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  https://api.klicktipp.com\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  https://api.klicktipp.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints defined in this specification are relative to this base URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/base-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KlickTipp Listbuilding API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as its response format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints return JSON responses containing structured payloads and error information. Integrations are expected to consume and validate JSON responses exclusively."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/response-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/data-formats-and-validation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Formats and Validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time values must always be provided as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamps (seconds)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the data field type "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only timestamps representing the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first day of the Unix epoch date (00:00:00 UTC)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted. Any time-of-day information beyond the day boundary is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formatted date strings, locale-specific formats, and timezone annotations are not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect field formats are one of the most common causes of errors when using the Listbuilding API. Always ensure that submitted values match the expected field type definitions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.klicktipp.com/guides/data-field-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data field types and Inputs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/listbuilding-api/section/data-formats-and-validation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors are returned as JSON responses and typically use HTTP status code "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"406"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", depending on the failure type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each error includes a numeric error code that should be handled explicitly by the integrating system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.klicktipp.com/guides/error-handling"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Handling"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This specification is designed to support "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"simple, secure, and predictable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list-building integrations with KlickTipp."},"children":[]}]}]}]}],"sectionId":"/listbuilding-api/section/error-handling"}]}]}},{"type":"link","label":"Authentication Model","link":"/listbuilding-api/section/authentication-model","routeSlug":"/listbuilding-api/section/authentication-model","content":null},{"type":"link","label":"Intended Usage","link":"/listbuilding-api/section/intended-usage","routeSlug":"/listbuilding-api/section/intended-usage","content":null},{"type":"link","label":"Core Endpoints","link":"/listbuilding-api/section/core-endpoints","routeSlug":"/listbuilding-api/section/core-endpoints","content":null},{"type":"link","label":"Base URL","link":"/listbuilding-api/section/base-url","routeSlug":"/listbuilding-api/section/base-url","content":null},{"type":"link","label":"Response Format","link":"/listbuilding-api/section/response-format","routeSlug":"/listbuilding-api/section/response-format","content":null},{"type":"link","label":"Data Formats and Validation","link":"/listbuilding-api/section/data-formats-and-validation","routeSlug":"/listbuilding-api/section/data-formats-and-validation","content":null},{"type":"link","label":"Error Handling","link":"/listbuilding-api/section/error-handling","routeSlug":"/listbuilding-api/section/error-handling","content":null},{"type":"group","label":"Listbuilding via API Key","link":"/listbuilding-api/listbuilding-via-api-key","routeSlug":"/listbuilding-api/listbuilding-via-api-key","items":[{"label":"Signin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signin","routeSlug":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signin","metadata":{"seo":{"title":"Signin","description":"Creates or updates a contact and associates the tag linked to the API key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.signin","name":"Signin","isWebhook":false,"pointer":"/paths/~1subscriber~1signin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a contact and associates the tag linked to the API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" On success, the endpoint returns a system-generated redirect URL depending on the opt-in configuration in KlickTipp."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Double Opt-in, the URL points to a pending page indicating that email confirmation is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Single Opt-in, the URL points to a final thank-you page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client may use this URL for optional redirection; the API itself does not perform any redirect."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"}},"schemaId":"components/schemas/SubscriberCreateWithApikeySchema","pointer":"/paths/~1subscriber~1signin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/signin","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"}},"responseCodes":["200","400","401","406"],"pointer":"/subscriber/signin","href":"listbuilding-via-api-key/api.subscriber.signin","openApiOperationId":"api.subscriber.signin","summary":"Signin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberCreateWithApikeySchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateWithApikeySchema"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success Response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request Response (400).\n\nCheck your request for malformed or missing parameters.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized Response (401).\n\nCheck username and password, or possibly other required parameters.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/401/content/application~1json/example"]},{"code":"406","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Acceptable Response (406)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response content for further error details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, a detail error code may be returned:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscription not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber email not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Field validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber not subscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber update failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address change not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Untag smarttag not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"32"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address SMS number required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - List not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tag not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User group not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"405"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"406"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tier not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"501"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Password required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"504"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - First name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"505"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Last name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"506"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"507"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"508"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User update failed"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signin/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signin/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1signin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1subscriber~1signin/post/responses/401/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signin/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signin/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listbuilding-via-api-key/api.subscriber.signin"}],"panels":[]}]},"httpPath":"/subscriber/signin"},{"label":"Signoff","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signoff","routeSlug":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signoff","metadata":{"seo":{"title":"Signoff","description":"Unsubscribes a contact via the API key and prevents further communication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.signoff","name":"Signoff","isWebhook":false,"pointer":"/paths/~1subscriber~1signoff/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signoff","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unsubscribes a contact via the API key and prevents further communication."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema","pointer":"/paths/~1subscriber~1signoff/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/signoff","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"responseCodes":["200","406"],"pointer":"/subscriber/signoff","href":"listbuilding-via-api-key/api.subscriber.signoff","openApiOperationId":"api.subscriber.signoff","summary":"Signoff"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success Response (200).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"406","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Acceptable Response (406)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response content for further error details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, a detail error code may be returned:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscription not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber email not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Field validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber not subscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber update failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address change not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Untag smarttag not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"32"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address SMS number required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - List not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tag not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User group not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"405"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"406"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tier not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"501"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Password required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"504"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - First name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"505"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Last name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"506"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"507"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"508"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User update failed"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1signoff/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"406","schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listbuilding-via-api-key/api.subscriber.signoff"}],"panels":[]}]},"httpPath":"/subscriber/signoff"},{"label":"Signout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signout","routeSlug":"/listbuilding-api/listbuilding-via-api-key/api.subscriber.signout","metadata":{"seo":{"title":"Signout","description":"Removes the tag of a contact associated with the API key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.signout","name":"Signout","isWebhook":false,"pointer":"/paths/~1subscriber~1signout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the tag of a contact associated with the API key."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema","pointer":"/paths/~1subscriber~1signout/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/signout","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"responseCodes":["200","406"],"pointer":"/subscriber/signout","href":"listbuilding-via-api-key/api.subscriber.signout","openApiOperationId":"api.subscriber.signout","summary":"Signout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeWithApikeySchema"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success Response (200).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"406","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Acceptable Response (406)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response content for further error details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, a detail error code may be returned:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscription not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber email not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Field validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber not subscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Subscriber update failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address change not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Untag smarttag not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"32"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address SMS number required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - List not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tag not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User group not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"405"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"406"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tier not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"501"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Password required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"504"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - First name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"505"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Last name required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"506"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Username exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"507"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email address exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"508"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User update failed"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signout/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signout/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1signout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"406","schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signout/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1subscriber~1signout/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listbuilding-via-api-key/api.subscriber.signout"}],"panels":[]}]},"httpPath":"/subscriber/signout"}],"content":{"contentType":"group","meta":{"name":"Listbuilding via API Key"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listbuilding via API Key","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints for adding and removing subscribers using an API key–based authentication model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These operations are optimized for secure listbuilding scenarios where full API authentication is not required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriber/signin","summary":"Signin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/listbuilding-via-api-key/api.subscriber.signin","deprecated":false},{"title":"/subscriber/signoff","summary":"Signoff","prefix":{"name":"post","color":"post"},"badges":[],"link":"/listbuilding-via-api-key/api.subscriber.signoff","deprecated":false},{"title":"/subscriber/signout","summary":"Signout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/listbuilding-via-api-key/api.subscriber.signout","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SubscriberCreateWithApikeySchema":{"id":"components/schemas/SubscriberCreateWithApikeySchema","kind":"json-schema","title":"SubscriberCreateWithApikeySchema","data":{"required":["apikey"],"properties":{"apikey":{"description":"API key","type":"string","example":"{{api_key}}"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid email address and must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsnumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address must be unique per contact."},"children":[]}]}]}],"type":"string","example":"alex.example@klicktipp.example","nullable":true},"smsnumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number in international format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsnumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS number must be unique per contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted input:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+4912345678"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"004912345678"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stored format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"004912345678"},"children":[]}]}]}]}],"type":"string","example":"+491701234567","nullable":true},"fields":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional custom fields for the subscriber."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keys must match the field names configured in KlickTipp."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each field expects a specific data format depending on its field type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Line"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Single-line text without line breaks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alex Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Paragraph"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Text with paragraphs. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to separate paragraphs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dies ist ein Text.\\nMit Absatz."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Integer value. No dot, no comma."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"42"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Decimal Number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Decimal value. Output always uses a dot as decimal separator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1999"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Output "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"19.99"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Valid web address. Must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://klicktipp.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unix timestamp between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"86399"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (seconds since midnight)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"52200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (14:30 GMT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unix timestamp in seconds. Date formats like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD.MM.YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1715126400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (08.05.2024 GMT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date & Time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unix timestamp in seconds. Do not send formatted date strings or values with spaces."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1715603400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (13.05.2024 12:30:00 GMT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTML"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTML-formatted content. Only use this type if the field explicitly allows HTML."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<strong>Hello World</strong>"},"children":[]}]}]}]}],"type":"object","example":{"fieldFirstName":"Alex","fieldLastName":"Example","fieldCompanyName":"Example Corp","fieldStreet1":"Example Street 1","fieldStreet2":"","fieldCity":"Berlin","fieldState":"Berlin","fieldZip":"10115","fieldCountry":"DE","fieldPrivatePhone":"+491701234567","fieldMobilePhone":"+491701234567","fieldPhone":"+492201234567","fieldFax":"4922012345678","fieldWebsite":"https://www.klicktipp.example","fieldBirthday":"755222400","fieldLeadValue":"100","field12345":"Custom Field Value"},"nullable":true,"additionalProperties":{"type":"string"}}},"type":"object"}},"components/schemas/SubscriberUnsubscribeWithApikeySchema":{"id":"components/schemas/SubscriberUnsubscribeWithApikeySchema","kind":"json-schema","title":"SubscriberUnsubscribeWithApikeySchema","data":{"required":["apikey","email"],"properties":{"apikey":{"description":"API key","type":"string","example":"{{api_key}}"},"email":{"description":"Email address of the subscriber","type":"string","example":"alex.example@klicktipp.example"}},"type":"object"}},"schema_19":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"oneOf":[{"type":"object"},{"type":"array","items":{"type":"string"}}]},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","items":{"type":"boolean"},"example":[true]},"id":"schema_21"}},"exampleStore":{"paths/~1subscriber~1signin/post/responses/200/content/application~1json/example":{"value":["https://klick.example.com/pending/1z3z6zzpz7b76"],"id":"paths/~1subscriber~1signin/post/responses/200/content/application~1json/example"},"paths/~1subscriber~1signin/post/responses/400/content/application~1json/example":{"value":["The key \"username\" must be a string."],"id":"paths/~1subscriber~1signin/post/responses/400/content/application~1json/example"},"paths/~1subscriber~1signin/post/responses/401/content/application~1json/example":{"value":["Wrong username or password."],"id":"paths/~1subscriber~1signin/post/responses/401/content/application~1json/example"},"paths/~1subscriber~1signin/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1signin/post/responses/406/content/application~1json/example"},"paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1signoff/post/responses/406/content/application~1json/example"},"paths/~1subscriber~1signout/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1signout/post/responses/406/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}]},"options":{"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]},"hideReplay":false,"hideSidebar":true,"mockServer":{"url":"/_mock/listbuilding-api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/listbuilding-api.json?download"},{"url":"/_bundle/listbuilding-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"KlickTipp Listbuilding API","description":"This specification describes the **KlickTipp Listbuilding API**.\n\nIt is intended for external tools, websites, and automation platforms that integrate KlickTipp list-building functionality using **API Key authentication**. Typical use cases include newsletter sign-up forms, lead magnets, landing pages, and no-code or iPaaS-based automations.\n\nThe Listbuilding API provides a restricted and purpose-built interface for managing contacts **without requiring full account authentication**. Using an API key, external systems can add or update contacts, assign or remove a tag, trigger opt-in processes, or unsubscribe contacts from further communication.\n\n---\n\n## Authentication Model\n\nAll endpoints in this specification use **API Key authentication**.\n\nThe API key is generated in KlickTipp under:\n\nListbuilding → New Listbuilding → Entry via API key\n\nEach API key is permanently linked to a specific opt-in process and tag. This defines the scope and behavior of the integration.\n\nAuthentication is performed by sending the API key **directly in the request body**. No session handling or cookies are required.\n\nDocumentation:  \n[How to Create an API Key](https://developers.klicktipp.com/guides/listbuilding-api)\n---\n\n## Intended Usage\n\nThis API is optimized for:\n\n- External signup and opt-in forms  \n- Embedded integrations in websites such as WordPress or landing page builders  \n- Automated lead processing via third-party platforms  \n\nIt is **not intended** for administrative workflows or full account management.\n\n---\n\n## Core Endpoints\n\nThe Listbuilding API focuses on a small, stable set of endpoints designed for external systems:\n\n- **Signin**  \n  Creates or updates a contact and associates the tag linked to the API key\n\n- **Signout**  \n  Removes the tag of a contact associated with the API key\n\n- **Signoff**  \n  Unsubscribes a contact via the API key and prevents further communication\n\n---\n\n## Base URL\n\nThe base URL for the KlickTipp API production environment is:\n\n```\n  https://api.klicktipp.com\n```\n\nAll endpoints defined in this specification are relative to this base URL.\n\n---\n\n## Response Format\n\nThe KlickTipp Listbuilding API uses **JSON** as its response format.\n\nAll endpoints return JSON responses containing structured payloads and error information. Integrations are expected to consume and validate JSON responses exclusively.\n\n---\n\n## Data Formats and Validation\n\nDate and time values must always be provided as **Unix timestamps (seconds)**.\n\nFor the data field type **Time** only timestamps representing the **first day of the Unix epoch date (00:00:00 UTC)** are accepted. Any time-of-day information beyond the day boundary is rejected.\n\nFormatted date strings, locale-specific formats, and timezone annotations are not supported.\n\nIncorrect field formats are one of the most common causes of errors when using the Listbuilding API. Always ensure that submitted values match the expected field type definitions.\n\nDocumentation:  \n[Data field types and Inputs](https://developers.klicktipp.com/guides/data-field-types)\n\n---\n\n## Error Handling\n\nErrors are returned as JSON responses and typically use HTTP status code **403** or **406**, depending on the failure type.\n\nEach error includes a numeric error code that should be handled explicitly by the integrating system.\n\nDocumentation:  \n[Error Handling](https://developers.klicktipp.com/guides/error-handling)\n\n---\n\nThis specification is designed to support **simple, secure, and predictable** list-building integrations with KlickTipp."}},"baseSlug":"/listbuilding-api","routesMapping":{}}