{"items":[{"type":"link","label":"KlickTipp API","link":"/management-api","routeSlug":"/management-api","content":{"contentType":"overview","meta":{"name":"KlickTipp API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"management-api.json","url":"/_bundle/management-api.json?download"},{"kind":"download","label":"management-api.yaml","url":"/_bundle/management-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 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 Management 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 developers and integrators who want to interact directly with KlickTipp to manage contacts, tags, custom fields, opt-in processes, and automation workflows."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API can be used standalone or through third-party platforms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specification focuses on correct request formats, authentication mechanisms, response structures, and error handling to ensure reliable and predictable integrations."},"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":"Good to know:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API uses session-based cookie authentication. Interactive Try-It requests do not fully support this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For production testing click on the button to open our Collection in Postman."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"postman-run-button","data-postman-action":"collection/fork","data-postman-visibility":"public","data-postman-var-1":"45081328-af33033f-f8b3-4d38-b2ce-af1b9c3b2a28","data-postman-collection-url":"entityId=45081328-af33033f-f8b3-4d38-b2ce-af1b9c3b2a28&entityType=collection&workspaceId=c516bfec-10fe-4a61-a25e-0d5eb0361079"}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"script","attrs":{"type":"text/javascript"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  (function (p,o,s,t,m,a,n) {\n    !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });\n    !o.getElementById(s+t) && o.getElementsByTagName(\"head\")[0].appendChild((\n      (n = o.createElement(\"script\")),\n      (n.id = s+t), (n.async = 1), (n.src = m), n\n    ));\n  }(window, document, \"_pm\", \"PostmanRunObject\", \"https://run.pstmn.io/button.js\"));\n"},"children":[]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/management-api"}],"sectionId":"/management-api"},{"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":"/management-api/section/base-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access the API, you must authenticate and maintain a valid session."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most endpoints require cookie-based authentication."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the login endpoint with your KlickTipp username and password to obtain a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"session cookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must be sent with all subsequent requests."},"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":"Request Preparation"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace all placeholder values such as email addresses, IDs, or timestamps with valid test data."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid formats are a common source of errors."},"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":"Response Handling"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API returns structured payloads and numeric error codes."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always validate HTTP status codes and response bodies programmatically."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/management-api/section/getting-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication-overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KlickTipp Management API supports "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple authentication models"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", depending on the integration scenario."},"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":"Username and password authentication via session cookie"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typically used for internal tools and administrative workflows."},"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":"Developer key and customer key authentication"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intended for long-running, production-grade, or multi-tenant integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This model does not rely on session handling."},"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/management-api-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to authenticate and access the Management API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/management-api/section/authentication-overview"},{"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 Management API uses JSON 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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON responses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including structured data, timestamps, and error details."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrations are expected to consume and validate JSON exclusively."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/management-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":"Formatted date strings, locale-specific formats, and timezone annotations are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not supported"},"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":"Incorrect field formats are a frequent cause of validation errors."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"/management-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 typically returned with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status code 406"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and include a numeric error code in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrations should handle errors explicitly and provide meaningful diagnostics for debugging and monitoring."},"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 stable, predictable, and maintainable integrations with the KlickTipp platform."},"children":[]}]}]}]}],"sectionId":"/management-api/section/error-handling"}]}]}},{"type":"link","label":"Base URL","link":"/management-api/section/base-url","routeSlug":"/management-api/section/base-url","content":null},{"type":"link","label":"Getting Started","link":"/management-api/section/getting-started","routeSlug":"/management-api/section/getting-started","content":null},{"type":"link","label":"Authentication Overview","link":"/management-api/section/authentication-overview","routeSlug":"/management-api/section/authentication-overview","content":null},{"type":"link","label":"Response Format","link":"/management-api/section/response-format","routeSlug":"/management-api/section/response-format","content":null},{"type":"link","label":"Data Formats and Validation","link":"/management-api/section/data-formats-and-validation","routeSlug":"/management-api/section/data-formats-and-validation","content":null},{"type":"link","label":"Error Handling","link":"/management-api/section/error-handling","routeSlug":"/management-api/section/error-handling","content":null},{"type":"group","label":"Authentication","link":"/management-api/authentication","routeSlug":"/management-api/authentication","items":[{"label":"Login","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/authentication/api.account.login","routeSlug":"/management-api/authentication/api.account.login","metadata":{"seo":{"title":"Login","description":"Logs into the API and retrieves session details for further interactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.account.login","name":"Login","isWebhook":false,"pointer":"/paths/~1account~1login/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs into the API and retrieves session details for further interactions."},{"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":"schema_22"},"application/x-www-form-urlencoded":{"schemaId":"schema_22"},"multipart/form-data":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1account~1login/post/requestBody","description":"User credentials (username and password) for authentication."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account/login","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_22"},"application/x-www-form-urlencoded":{"schemaId":"schema_22"},"multipart/form-data":{"schemaId":"schema_22"}},"responseCodes":["200","400","401","406"],"pointer":"/account/login","href":"authentication/api.account.login","openApiOperationId":"api.account.login","summary":"Login"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"schema_22","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"},"application/x-www-form-urlencoded":{"schemaId":"schema_22"},"multipart/form-data":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success Response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns session details and account information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response contains a session cookie in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Set-Cookie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response also contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"session_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sessid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body for manual usage."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23","exampleIds":["paths/~1account~1login/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_23","exampleIds":["paths/~1account~1login/post/responses/200/content/application~1json/example"],"headers":{"Set-Cookie":{"description":"Session cookie for authentication.","schema":{"type":"string","example":"SSESSabc=xyz123; path=/; secure; httponly;"}}},"headerSchemaId":"schema_24"},{"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_25","exampleIds":["paths/~1account~1login/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1account~1login/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_25","exampleIds":["paths/~1account~1login/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1account~1login/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_26","exampleIds":["paths/~1account~1login/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1account~1login/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1account~1login/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_23","exampleIds":["paths/~1account~1login/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23","exampleIds":["paths/~1account~1login/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_25","exampleIds":["paths/~1account~1login/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1account~1login/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_25","exampleIds":["paths/~1account~1login/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1account~1login/post/responses/401/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1account~1login/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1account~1login/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/api.account.login"}],"panels":[]}]},"httpPath":"/account/login"},{"label":"Logout from API","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/authentication/api.account.logout","routeSlug":"/management-api/authentication/api.account.logout","metadata":{"seo":{"title":"Logout from API","description":"Logs out of the API and ends the session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.account.logout","name":"Logout from API","isWebhook":false,"pointer":"/paths/~1account~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout from API","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs out of the API and ends the session."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account/logout","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/account/logout","href":"authentication/api.account.logout","openApiOperationId":"api.account.logout","summary":"Logout from API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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."}],"pointer":"/paths/~1account~1logout/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/api.account.logout"}],"panels":[]}]},"httpPath":"/account/logout"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for authenticating against the KlickTipp API and managing API access.\nThese operations are used to establish and terminate authenticated sessions or to validate credentials required for protected API requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account/login","summary":"Login","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/api.account.login","deprecated":false},{"title":"/account/logout","summary":"Logout from API","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/api.account.logout","deprecated":false}]}]}]}]}},{"type":"group","label":"Contacts","link":"/management-api/contacts","routeSlug":"/management-api/contacts","items":[{"label":"List Contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.index","routeSlug":"/management-api/contacts/api.subscriber.index","metadata":{"seo":{"title":"List Contacts","description":"Lists the IDs of all contacts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.index","name":"List Contacts","isWebhook":false,"pointer":"/paths/~1subscriber/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the IDs of all contacts."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_27","description":"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.","example":"subscribed,pending"},{"name":"bounceStatus","in":"query","schemaId":"schema_28","description":"Filter contacts by their bounce status (hardbounce, softbounce, spambounce, nobounce). If no value is selected, the filter defaults to softbounce, spambounce, and nobounce.","example":"nobounce,softbounce"}],"pointer":"/paths/~1subscriber/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriber","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"example":"subscribed,pending","schemaId":"schema_27","style":"form"},{"name":"bounceStatus","in":"query","required":false,"example":"nobounce,softbounce","schemaId":"schema_28","style":"form"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404"],"pointer":"/subscriber","href":"contacts/api.subscriber.index","openApiOperationId":"api.subscriber.index","summary":"List Contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_29","exampleIds":["paths/~1subscriber/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_29","exampleIds":["paths/~1subscriber/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1subscriber/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_29","exampleIds":["paths/~1subscriber/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1subscriber/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.index"}],"panels":[]}]},"httpPath":"/subscriber"},{"label":"Add or Update Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.create","routeSlug":"/management-api/contacts/api.subscriber.create","metadata":{"seo":{"title":"Add or Update Contact","description":"Adds a new contact. If a contact with the same email already exists, it will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.create","name":"Add or Update Contact","isWebhook":false,"pointer":"/paths/~1subscriber/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add or Update Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new contact. If a contact with the same email already exists, it will be updated."},{"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/SubscriberCreateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateSchema"}},"schemaId":"components/schemas/SubscriberCreateSchema","pointer":"/paths/~1subscriber/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberCreateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateSchema"}},"responseCodes":["200","403","406"],"pointer":"/subscriber","href":"contacts/api.subscriber.create","openApiOperationId":"api.subscriber.create","summary":"Add or Update Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberCreateSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberCreateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberCreateSchema"}},"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":"components/schemas/SubscriberDetailSchema"}},"schemaId":"components/schemas/SubscriberDetailSchema"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber/post/responses/403/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_26","exampleIds":["paths/~1subscriber/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriberDetailSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriberDetailSchema"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber/post/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.create"}],"panels":[]}]},"httpPath":"/subscriber"},{"label":"Get Contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.retrieve","routeSlug":"/management-api/contacts/api.subscriber.retrieve","metadata":{"seo":{"title":"Get Contact","description":"Returns the complete data of a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.retrieve","name":"Get Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1{subscriberid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the complete data of a contact."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriberid","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the contact. This can be either:"},"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":"Internal Subscriber ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact ID)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for internal, server-side integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"987654321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"External Subscriber Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact Key)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for external communication such as email links, redirect URLs and form integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01234abcdefghij56789"},"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":"Both identifiers can be used interchangeably in this endpoint."},"children":[]}]}]}],"required":true,"example":"987654321"}],"pointer":"/paths/~1subscriber~1{subscriberid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriber/{subscriberid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"subscriberid","in":"path","required":true,"example":"987654321","schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404"],"pointer":"/subscriber/{subscriberid}","href":"contacts/api.subscriber.retrieve","openApiOperationId":"api.subscriber.retrieve","summary":"Get Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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":"components/schemas/SubscriberDetailSchema"}},"schemaId":"components/schemas/SubscriberDetailSchema"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1{subscriberid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriberDetailSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriberDetailSchema"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.retrieve"}],"panels":[]}]},"httpPath":"/subscriber/{subscriberid}"},{"label":"Update Contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.update","routeSlug":"/management-api/contacts/api.subscriber.update","metadata":{"seo":{"title":"Update Contact","description":"Updates a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.update","name":"Update Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1{subscriberid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a contact."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriberid","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the contact. This can be either:"},"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":"Internal Subscriber ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact ID)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for internal, server-side integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"987654321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"External Subscriber Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact Key)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for external communication such as email links, redirect URLs and form integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01234abcdefghij56789"},"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":"Both identifiers can be used interchangeably in this endpoint."},"children":[]}]}]}],"required":true,"example":"987654321"}],"pointer":"/paths/~1subscriber~1{subscriberid}/put/parameters"},{"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/SubscriberUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUpdateSchema"}},"schemaId":"components/schemas/SubscriberUpdateSchema","pointer":"/paths/~1subscriber~1{subscriberid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscriber/{subscriberid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"subscriberid","in":"path","required":true,"example":"987654321","schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUpdateSchema"}},"responseCodes":["200","403","406"],"pointer":"/subscriber/{subscriberid}","href":"contacts/api.subscriber.update","openApiOperationId":"api.subscriber.update","summary":"Update Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUpdateSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUpdateSchema"}},"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/403/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_26","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1{subscriberid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.update"}],"panels":[]}]},"httpPath":"/subscriber/{subscriberid}"},{"label":"Delete Contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.delete","routeSlug":"/management-api/contacts/api.subscriber.delete","metadata":{"seo":{"title":"Delete Contact","description":"Deletes a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.delete","name":"Delete Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1{subscriberid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a contact."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriberid","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the contact. This can be either:"},"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":"Internal Subscriber ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact ID)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for internal, server-side integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"987654321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"External Subscriber Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Contact Key)"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for external communication such as email links, redirect URLs and form integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01234abcdefghij56789"},"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":"Both identifiers can be used interchangeably in this endpoint."},"children":[]}]}]}],"required":true,"example":"987654321"}],"pointer":"/paths/~1subscriber~1{subscriberid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriber/{subscriberid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"subscriberid","in":"path","required":true,"example":"987654321","schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","406"],"pointer":"/subscriber/{subscriberid}","href":"contacts/api.subscriber.delete","openApiOperationId":"api.subscriber.delete","summary":"Delete Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/403/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_26","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1{subscriberid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.delete"}],"panels":[]}]},"httpPath":"/subscriber/{subscriberid}"},{"label":"Unsubscribe Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.unsubscribe","routeSlug":"/management-api/contacts/api.subscriber.unsubscribe","metadata":{"seo":{"title":"Unsubscribe Contact","description":"Unsubscribes a contact, preventing further communication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.unsubscribe","name":"Unsubscribe Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1unsubscribe/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribe Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unsubscribes a contact, preventing 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/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"schemaId":"components/schemas/SubscriberUnsubscribeSchema","pointer":"/paths/~1subscriber~1unsubscribe/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/unsubscribe","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"responseCodes":["200","403","406"],"pointer":"/subscriber/unsubscribe","href":"contacts/api.subscriber.unsubscribe","openApiOperationId":"api.subscriber.unsubscribe","summary":"Unsubscribe Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUnsubscribeSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/403/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_26","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1unsubscribe/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.unsubscribe"}],"panels":[]}]},"httpPath":"/subscriber/unsubscribe"},{"label":"Search Contact ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.search","routeSlug":"/management-api/contacts/api.subscriber.search","metadata":{"seo":{"title":"Search Contact ID","description":"Returns the contact ID for an email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.search","name":"Search Contact ID","isWebhook":false,"pointer":"/paths/~1subscriber~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Contact ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the contact ID for an email address."},{"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/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"schemaId":"components/schemas/SubscriberUnsubscribeSchema","pointer":"/paths/~1subscriber~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/search","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"responseCodes":["200","403","404"],"pointer":"/subscriber/search","href":"contacts/api.subscriber.search","openApiOperationId":"api.subscriber.search","summary":"Search Contact ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUnsubscribeSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUnsubscribeSchema"}},"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_32","exampleIds":["paths/~1subscriber~1search/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_32","exampleIds":["paths/~1subscriber~1search/post/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_32","exampleIds":["paths/~1subscriber~1search/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1subscriber~1search/post/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1search/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.search"}],"panels":[]}]},"httpPath":"/subscriber/search"},{"label":"Search Tagged Contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contacts/api.subscriber.tagged","routeSlug":"/management-api/contacts/api.subscriber.tagged","metadata":{"seo":{"title":"Search Tagged Contacts","description":"Returns the contact IDs and tag-assignment timestamps for contacts associated with a tag identified by its tag ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.tagged","name":"Search Tagged Contacts","isWebhook":false,"pointer":"/paths/~1subscriber~1tagged/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Tagged Contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the contact IDs and tag-assignment timestamps for contacts associated with a tag identified by its tag ID.\n\nSupports manual tags and smart tags whose IDs were obtained from the Get Contact endpoint. For smart tags, the returned timestamp represents the system-recorded tag assignment time."},{"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/SubscriberTaggedSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTaggedSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTaggedSchema"}},"schemaId":"components/schemas/SubscriberTaggedSchema","pointer":"/paths/~1subscriber~1tagged/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/tagged","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberTaggedSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTaggedSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTaggedSchema"}},"responseCodes":["200","403"],"pointer":"/subscriber/tagged","href":"contacts/api.subscriber.tagged","openApiOperationId":"api.subscriber.tagged","summary":"Search Tagged Contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberTaggedSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberTaggedSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTaggedSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTaggedSchema"}},"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_33","exampleIds":["paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1tagged/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/api.subscriber.tagged"}],"panels":[]}]},"httpPath":"/subscriber/tagged"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for creating, updating, and retrieving subscriber data in KlickTipp.\nThese operations allow external systems to manage contact records, including core profile information and custom data fields."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriber","summary":"List Contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/api.subscriber.index","deprecated":false},{"title":"/subscriber","summary":"Add or Update Contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/api.subscriber.create","deprecated":false},{"title":"/subscriber/{subscriberid}","summary":"Get Contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/api.subscriber.retrieve","deprecated":false},{"title":"/subscriber/{subscriberid}","summary":"Update Contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/api.subscriber.update","deprecated":false},{"title":"/subscriber/{subscriberid}","summary":"Delete Contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/api.subscriber.delete","deprecated":false},{"title":"/subscriber/unsubscribe","summary":"Unsubscribe Contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/api.subscriber.unsubscribe","deprecated":false},{"title":"/subscriber/search","summary":"Search Contact ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/api.subscriber.search","deprecated":false},{"title":"/subscriber/tagged","summary":"Search Tagged Contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/api.subscriber.tagged","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Tagging","link":"/management-api/contact-tagging","routeSlug":"/management-api/contact-tagging","items":[{"label":"Tag Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contact-tagging/api.subscriber.tag","routeSlug":"/management-api/contact-tagging/api.subscriber.tag","metadata":{"seo":{"title":"Tag Contact","description":"Adds one or more tags to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.tag","name":"Tag Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1tag/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds one or more tags to a contact."},{"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/SubscriberTagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTagSchema"}},"schemaId":"components/schemas/SubscriberTagSchema","pointer":"/paths/~1subscriber~1tag/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/tag","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberTagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTagSchema"}},"responseCodes":["200","403","406"],"pointer":"/subscriber/tag","href":"contact-tagging/api.subscriber.tag","openApiOperationId":"api.subscriber.tag","summary":"Tag Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberTagSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberTagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberTagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberTagSchema"}},"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tag/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tag/post/responses/403/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_26","exampleIds":["paths/~1subscriber~1tag/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1tag/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1tag/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tag/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1tag/post/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber~1tag/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1tag/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-tagging/api.subscriber.tag"}],"panels":[]}]},"httpPath":"/subscriber/tag"},{"label":"Untag Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/contact-tagging/api.subscriber.untag","routeSlug":"/management-api/contact-tagging/api.subscriber.untag","metadata":{"seo":{"title":"Untag Contact","description":"Removes a tag from a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.subscriber.untag","name":"Untag Contact","isWebhook":false,"pointer":"/paths/~1subscriber~1untag/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a tag from a contact."},{"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/SubscriberUntagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUntagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUntagSchema"}},"schemaId":"components/schemas/SubscriberUntagSchema","pointer":"/paths/~1subscriber~1untag/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriber/untag","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriberUntagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUntagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUntagSchema"}},"responseCodes":["200","403","406"],"pointer":"/subscriber/untag","href":"contact-tagging/api.subscriber.untag","openApiOperationId":"api.subscriber.untag","summary":"Untag Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/SubscriberUntagSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriberUntagSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/SubscriberUntagSchema"},"multipart/form-data":{"schemaId":"components/schemas/SubscriberUntagSchema"}},"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1untag/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1untag/post/responses/403/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_26","exampleIds":["paths/~1subscriber~1untag/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1untag/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1subscriber~1untag/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1subscriber~1untag/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1subscriber~1untag/post/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1subscriber~1untag/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1subscriber~1untag/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-tagging/api.subscriber.untag"}],"panels":[]}]},"httpPath":"/subscriber/untag"}],"content":{"contentType":"group","meta":{"name":"Contact Tagging"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Tagging","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for assigning and removing tags from subscribers.\nTagging operations are used to control automations, trigger workflows, and reflect changes in subscriber state based on external events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriber/tag","summary":"Tag Contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-tagging/api.subscriber.tag","deprecated":false},{"title":"/subscriber/untag","summary":"Untag Contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-tagging/api.subscriber.untag","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Fields","link":"/management-api/data-fields","routeSlug":"/management-api/data-fields","items":[{"label":"List Data Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/data-fields/api.customfield.index","routeSlug":"/management-api/data-fields/api.customfield.index","metadata":{"seo":{"title":"List Data Fields","description":"Lists the IDs and names of all data fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.customfield.index","name":"List Data Fields","isWebhook":false,"pointer":"/paths/~1field/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Data Fields","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":"Lists the IDs and names of all data fields."},"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":" data field IDs in this endpoint are prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/field","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403"],"pointer":"/field","href":"data-fields/api.customfield.index","openApiOperationId":"api.customfield.index","summary":"List Data Fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_33","exampleIds":["paths/~1field/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1field/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1field/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1field/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1field/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1field/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1field/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-fields/api.customfield.index"}],"panels":[]}]},"httpPath":"/field"},{"label":"Get Data Field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/data-fields/api.customfield.retrieve","routeSlug":"/management-api/data-fields/api.customfield.retrieve","metadata":{"seo":{"title":"Get Data Field","description":"Gets the ID and the name of a data field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.customfield.retrieve","name":"Get Data Field","isWebhook":false,"pointer":"/paths/~1field~1{fieldid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Data Field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the ID and the name of a data field."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fieldid","in":"path","schemaId":"schema_30","description":"Internal ID of the Data field","required":true,"example":"12345"}],"pointer":"/paths/~1field~1{fieldid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/field/{fieldid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"fieldid","in":"path","required":true,"example":"12345","schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404"],"pointer":"/field/{fieldid}","href":"data-fields/api.customfield.retrieve","openApiOperationId":"api.customfield.retrieve","summary":"Get Data Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_34","exampleIds":["paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_34","exampleIds":["paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1field~1{fieldid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","exampleIds":["paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34","exampleIds":["paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-fields/api.customfield.retrieve"}],"panels":[]}]},"httpPath":"/field/{fieldid}"}],"content":{"contentType":"group","meta":{"name":"Data Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Fields","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing custom data fields associated with subscribers.\nThese operations are used to define, retrieve, and map structured subscriber data for personalization and integration purposes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/field","summary":"List Data Fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-fields/api.customfield.index","deprecated":false},{"title":"/field/{fieldid}","summary":"Get Data Field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-fields/api.customfield.retrieve","deprecated":false}]}]}]}]}},{"type":"group","label":"Opt-In Processes","link":"/management-api/opt-in-processes","routeSlug":"/management-api/opt-in-processes","items":[{"label":"List Opt-in Processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/opt-in-processes/api.optin.index","routeSlug":"/management-api/opt-in-processes/api.optin.index","metadata":{"seo":{"title":"List Opt-in Processes","description":"Lists the IDs and names of all opt-in processes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.optin.index","name":"List Opt-in Processes","isWebhook":false,"pointer":"/paths/~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Opt-in Processes","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":"Lists the IDs and names of all opt-in processes."},"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":" The Id without a name is the Default Double Opt-In present in each KlickTipp Account."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/list","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403"],"pointer":"/list","href":"opt-in-processes/api.optin.index","openApiOperationId":"api.optin.index","summary":"List Opt-in Processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_33","exampleIds":["paths/~1list/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1list/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1list/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1list/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1list/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/opt-in-processes/api.optin.index"}],"panels":[]}]},"httpPath":"/list"},{"label":"Get Opt-in Process","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/opt-in-processes/api.optin.retrieve","routeSlug":"/management-api/opt-in-processes/api.optin.retrieve","metadata":{"seo":{"title":"Get Opt-in Process","description":"Returns the complete data of an opt-in process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.optin.retrieve","name":"Get Opt-in Process","isWebhook":false,"pointer":"/paths/~1list~1{listid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Opt-in Process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the complete data of an opt-in process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listid","in":"path","schemaId":"schema_35","description":"Internal ID of the opt-in process","required":true,"example":45}],"pointer":"/paths/~1list~1{listid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/list/{listid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"listid","in":"path","required":true,"example":45,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404"],"pointer":"/list/{listid}","href":"opt-in-processes/api.optin.retrieve","openApiOperationId":"api.optin.retrieve","summary":"Get Opt-in Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_36"}},"schemaId":"schema_36"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1list~1{listid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1{listid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/opt-in-processes/api.optin.retrieve"}],"panels":[]}]},"httpPath":"/list/{listid}"},{"label":"Search Redirect URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/opt-in-processes/api.optin.redirect","routeSlug":"/management-api/opt-in-processes/api.optin.redirect","metadata":{"seo":{"title":"Search Redirect URL","description":"Search the redirection URL for a specific opt-in process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.optin.redirect","name":"Search Redirect URL","isWebhook":false,"pointer":"/paths/~1list~1redirect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Redirect URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search the redirection URL for a specific opt-in process."},{"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/OptInProcessRedirectSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OptInProcessRedirectSchema"},"multipart/form-data":{"schemaId":"components/schemas/OptInProcessRedirectSchema"}},"schemaId":"components/schemas/OptInProcessRedirectSchema","pointer":"/paths/~1list~1redirect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/list/redirect","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OptInProcessRedirectSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OptInProcessRedirectSchema"},"multipart/form-data":{"schemaId":"components/schemas/OptInProcessRedirectSchema"}},"responseCodes":["200","403","404"],"pointer":"/list/redirect","href":"opt-in-processes/api.optin.redirect","openApiOperationId":"api.optin.redirect","summary":"Search Redirect URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/OptInProcessRedirectSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OptInProcessRedirectSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OptInProcessRedirectSchema"},"multipart/form-data":{"schemaId":"components/schemas/OptInProcessRedirectSchema"}},"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_25","exampleIds":["paths/~1list~1redirect/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1list~1redirect/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1list~1redirect/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/opt-in-processes/api.optin.redirect"}],"panels":[]}]},"httpPath":"/list/redirect"}],"content":{"contentType":"group","meta":{"name":"Opt-In Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Opt-In Processes","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to opt-in workflows and subscription confirmation processes.\nThese operations support compliant subscriber onboarding, including single and double opt-in flows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/list","summary":"List Opt-in Processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/opt-in-processes/api.optin.index","deprecated":false},{"title":"/list/{listid}","summary":"Get Opt-in Process","prefix":{"name":"get","color":"get"},"badges":[],"link":"/opt-in-processes/api.optin.retrieve","deprecated":false},{"title":"/list/redirect","summary":"Search Redirect URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/opt-in-processes/api.optin.redirect","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/management-api/tags","routeSlug":"/management-api/tags","items":[{"label":"List Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/tags/api.tag.index","routeSlug":"/management-api/tags/api.tag.index","metadata":{"seo":{"title":"List Tags","description":"Lists the IDs and names of all manual tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.tag.index","name":"List Tags","isWebhook":false,"pointer":"/paths/~1tag/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the IDs and names of all manual tags.\n\nThis Endpoint does not list smart tags. Smart tag IDs can only be obtained from the Get Contact endpoint."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tag","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403"],"pointer":"/tag","href":"tags/api.tag.index","openApiOperationId":"api.tag.index","summary":"List Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_33","exampleIds":["paths/~1tag/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1tag/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1tag/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1tag/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1tag/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1tag/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/api.tag.index"}],"panels":[]}]},"httpPath":"/tag"},{"label":"Create Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/tags/api.tag.create","routeSlug":"/management-api/tags/api.tag.create","metadata":{"seo":{"title":"Create Tag","description":"Creates a new manual tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.tag.create","name":"Create Tag","isWebhook":false,"pointer":"/paths/~1tag/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new manual tag."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded","multipart/form-data","application/json"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagCreateSchema"},"application/json":{"schemaId":"components/schemas/TagCreateSchema"}},"schemaId":"components/schemas/TagCreateSchema","pointer":"/paths/~1tag/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tag","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagCreateSchema"},"application/json":{"schemaId":"components/schemas/TagCreateSchema"}},"responseCodes":["200","403","406"],"pointer":"/tag","href":"tags/api.tag.create","openApiOperationId":"api.tag.create","summary":"Create Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/TagCreateSchema","mediaTypes":["application/x-www-form-urlencoded","multipart/form-data","application/json"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagCreateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagCreateSchema"},"application/json":{"schemaId":"components/schemas/TagCreateSchema"}},"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_32","exampleIds":["paths/~1tag/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_32","exampleIds":["paths/~1tag/post/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag/post/responses/403/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_26","exampleIds":["paths/~1tag/post/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1tag/post/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1tag/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_32","exampleIds":["paths/~1tag/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1tag/post/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1tag/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag/post/responses/403/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1tag/post/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1tag/post/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/api.tag.create"}],"panels":[]}]},"httpPath":"/tag"},{"label":"Get Tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/tags/api.tag.retrieve","routeSlug":"/management-api/tags/api.tag.retrieve","metadata":{"seo":{"title":"Get Tag","description":"Returns the name and description of a tag identified by its tag ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.tag.retrieve","name":"Get Tag","isWebhook":false,"pointer":"/paths/~1tag~1{tagid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the name and description of a tag identified by its tag ID.\n\nSupports manual tags and smart tags whose IDs were obtained from the Get Contact endpoint. This endpoint does not provide a catalog of all smart tags."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagid","in":"path","schemaId":"schema_35","description":"Internal ID of the tag","required":true,"example":21}],"pointer":"/paths/~1tag~1{tagid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tag/{tagid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"tagid","in":"path","required":true,"example":21,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404"],"pointer":"/tag/{tagid}","href":"tags/api.tag.retrieve","openApiOperationId":"api.tag.retrieve","summary":"Get Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_37","exampleIds":["paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_37","exampleIds":["paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1tag~1{tagid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_37","exampleIds":["paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/api.tag.retrieve"}],"panels":[]}]},"httpPath":"/tag/{tagid}"},{"label":"Update Tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/tags/api.tag.update","routeSlug":"/management-api/tags/api.tag.update","metadata":{"seo":{"title":"Update Tag","description":"Updates a manual tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.tag.update","name":"Update Tag","isWebhook":false,"pointer":"/paths/~1tag~1{tagid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a manual tag.\n\nThis Endpoint does not support to update system generated smart tags."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagid","in":"path","schemaId":"schema_35","description":"Internal ID of the tag","required":true,"example":21}],"pointer":"/paths/~1tag~1{tagid}/put/parameters"},{"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/TagUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagUpdateSchema"}},"schemaId":"components/schemas/TagUpdateSchema","pointer":"/paths/~1tag~1{tagid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tag/{tagid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"tagid","in":"path","required":true,"example":21,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TagUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagUpdateSchema"}},"responseCodes":["200","403","404","406"],"pointer":"/tag/{tagid}","href":"tags/api.tag.update","openApiOperationId":"api.tag.update","summary":"Update Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"schemaId":"components/schemas/TagUpdateSchema","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagUpdateSchema"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TagUpdateSchema"},"multipart/form-data":{"schemaId":"components/schemas/TagUpdateSchema"}},"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/404/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_26","exampleIds":["paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1tag~1{tagid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/put/responses/404/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/api.tag.update"}],"panels":[]}]},"httpPath":"/tag/{tagid}"},{"label":"Delete Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/management-api/tags/api.tag.delete","routeSlug":"/management-api/tags/api.tag.delete","metadata":{"seo":{"title":"Delete Tag","description":"Deletes a manual tag and removes it from all contacts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.tag.delete","name":"Delete Tag","isWebhook":false,"pointer":"/paths/~1tag~1{tagid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a manual tag and removes it from all contacts.\n\nThis Endpoint does not support to delete system generated smart tags."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagid","in":"path","schemaId":"schema_35","description":"Internal ID of the tag","required":true,"example":21}],"pointer":"/paths/~1tag~1{tagid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tag/{tagid}","servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"parameters":{"path":[{"name":"tagid","in":"path","required":true,"example":21,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","406"],"pointer":"/tag/{tagid}","href":"tags/api.tag.delete","openApiOperationId":"api.tag.delete","summary":"Delete Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.klicktipp.com","description":"KlickTipp REST API"}],"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_31"}},"schemaId":"schema_31"},{"code":"403","description":"Access Denied Response (403).\n\nYour account does not have the required permissions to access this resource.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found Response (404).\n\nThe specified resource could not be found.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/404/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_26","exampleIds":["paths/~1tag~1{tagid}/delete/responses/406/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/delete/responses/406/content/application~1json/example"]}],"pointer":"/paths/~1tag~1{tagid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"403","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1tag~1{tagid}/delete/responses/404/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/delete/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1tag~1{tagid}/delete/responses/406/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/api.tag.delete"}],"panels":[]}]},"httpPath":"/tag/{tagid}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing and querying available tags in KlickTipp.\nThese operations allow systems to retrieve tag metadata and understand which tags can be used for segmentation and automation control."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tag","summary":"List Tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/api.tag.index","deprecated":false},{"title":"/tag","summary":"Create Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/api.tag.create","deprecated":false},{"title":"/tag/{tagid}","summary":"Get Tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/api.tag.retrieve","deprecated":false},{"title":"/tag/{tagid}","summary":"Update Tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/api.tag.update","deprecated":false},{"title":"/tag/{tagid}","summary":"Delete Tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/api.tag.delete","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/OptInProcessRedirectSchema":{"id":"components/schemas/OptInProcessRedirectSchema","kind":"json-schema","title":"OptInProcessRedirectSchema","data":{"required":["listid","email"],"properties":{"listid":{"description":"Internal ID of the opt-in process","type":"string","example":"45"},"email":{"description":"Email address of the contact","type":"string","example":"alex.example@klicktipp.example"}},"type":"object"}},"components/schemas/SubscriberCreateSchema":{"id":"components/schemas/SubscriberCreateSchema","kind":"json-schema","title":"SubscriberCreateSchema","data":{"description":[{"$$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":[]}]}]}],"properties":{"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","format":"email","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},"listid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opt-in process ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, this opt-in process is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, the predefined double opt-in process is triggered automatically, which may trigger an email to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve available opt-in process IDs via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","example":12345,"nullable":true},"tagid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag ID assigned to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for segmentation and automation triggers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve available tag IDs via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","example":56789,"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":"+492201234567","fieldWebsite":"https://www.klicktipp.example","fieldBirthday":"755222400","fieldLeadValue":"100","field12345":"Custom Field Value"},"nullable":true,"additionalProperties":{"type":"string"}}},"type":"object"}},"components/schemas/SubscriberDetailSchema":{"id":"components/schemas/SubscriberDetailSchema","kind":"json-schema","title":"SubscriberDetailSchema","data":{"description":"Legacy subscriber detail representation. Field formats and semantics are not fully normalized.","required":["id","email","status","bounce","listid","optin","optin_ip","date","ip","unsubscription","unsubscription_ip","referrer","sms_phone","sms_status","sms_bounce","sms_date","sms_unsubscription","sms_referrer","fieldFirstName","fieldLastName","fieldCompanyName","fieldStreet1","fieldStreet2","fieldCity","fieldState","fieldZip","fieldCountry","fieldPrivatePhone","fieldMobilePhone","fieldPhone","fieldFax","fieldWebsite","fieldBirthday","fieldLeadValue","tags","smart_tags","manual_tags","notification_emails_sent","notification_emails_opened","notification_emails_clicked","emails_sent","emails_opened","emails_clicked","campaigns_started","campaigns_finished"],"properties":{"id":{"description":"Unique internal identifier of the contact","type":"string","example":"987654321"},"email":{"description":"Primary email address of the contact","type":"string","example":"alex.example@klicktipp.example"},"status":{"description":"Current email subscription status of the contact (state, legacy string value)","type":"string","example":"Subscribed"},"bounce":{"description":"Bounce status of the contact email address (state, legacy string value)","type":"string","example":"Not Bounced"},"listid":{"description":"ID of the opt-in process (list) the contact belongs to at the time of subscription","type":"string","example":"12345"},"optin":{"description":"Time when the opt-in process for email communication was initiated (legacy formatted datetime string)","type":"string","example":"01.01.2025 12:00:00"},"optin_ip":{"description":"IP address associated with initiating the opt-in process for email communication. Legacy behavior: For API-based subscriptions, this field may contain additional descriptive text and does not represent a pure IP address.","type":"string","example":"0.0.0.0"},"date":{"description":"Time when the opt-in process for email communication was successfully confirmed (legacy formatted datetime string)","type":"string","example":"01.01.2025 13:00:00"},"ip":{"description":"IP address associated with confirming the opt-in process for email communication. Legacy behavior: For API-based subscriptions, this field may contain additional descriptive text and does not represent a pure IP address.","type":"string","example":"0.0.0.0"},"unsubscription":{"description":"Time when the contact unsubscribed from email communication (legacy formatted datetime string). Empty if the contact is subscribed.","type":"string","example":""},"unsubscription_ip":{"description":"IP address associated with the unsubscription from email communication. Legacy behavior: For API-based unsubscriptions, this field may contain additional descriptive text. Empty if the contact is subscribed.","type":"string","example":""},"referrer":{"description":"Optional referrer indicating the website where the email subscription form was embedded at the time of opt-in initiation. Legacy best-effort field and often empty.","type":"string","example":"https://integration.example.com/webhooks/payment/ipn"},"sms_phone":{"description":"Phone number used for SMS communication","type":"string","example":"00491701234567"},"sms_status":{"description":"Current SMS subscription status of the phone number (state, legacy string value)","type":"string","example":"Subscribed"},"sms_bounce":{"description":"SMS bounce status of the phone number (state, legacy string value)","type":"string","example":"Not Bounced"},"sms_date":{"description":"Time when the SMS subscription became active (legacy formatted datetime string)","type":"string","example":"01.02.2025 12:00:00"},"sms_unsubscription":{"description":"Time when the contact unsubscribed from SMS communication (legacy formatted datetime string). Empty if subscribed.","type":"string","example":""},"sms_referrer":{"description":"Optional referrer indicating the website where the SMS subscription form was embedded at the time of opt-in initiation. Legacy best-effort field and often empty.","type":"string","example":"https://signup.example.com/sms-form"},"fieldFirstName":{"description":"Global data field: first name of the contact","type":"string","example":"Alex"},"fieldLastName":{"description":"Global data field: last name of the contact","type":"string","example":"Example"},"fieldCompanyName":{"description":"Global data field: company name of the contact","type":"string","example":"Example Corp"},"fieldStreet1":{"description":"Global data field: primary street address","type":"string","example":"Example Street 1"},"fieldStreet2":{"description":"Global data field: additional address information","type":"string","example":""},"fieldCity":{"description":"Global data field: city","type":"string","example":"Berlin"},"fieldState":{"description":"Global data field: state or region","type":"string","example":"Berlin"},"fieldZip":{"description":"Global data field: postal or ZIP code","type":"string","example":"10115"},"fieldCountry":{"description":"Global data field: country code","type":"string","example":"DE"},"fieldPrivatePhone":{"description":"Global data field: private phone number","type":"string","example":"00491701234567"},"fieldMobilePhone":{"description":"Global data field: mobile phone number","type":"string","example":"00491707654321"},"fieldPhone":{"description":"Global data field: business phone number","type":"string","example":"00492207654321"},"fieldFax":{"description":"Global data field: fax number","type":"string","example":"00492201234567"},"fieldWebsite":{"description":"Global data field: website URL","type":"string","example":"https://www.klicktipp.example"},"fieldBirthday":{"description":"Global data field: birthday stored as Unix timestamp (seconds)","type":"string","example":"755222400"},"fieldLeadValue":{"description":"Global data field: lead score or lead value","type":"string","example":"100"},"tags":{"description":"List of all tag IDs currently assigned to the contact, including manual and smart tags","type":"array","items":{"type":"string"},"example":["17","18","19","20"]},"smart_tags":{"description":"Smart tag IDs mapped to the Unix timestamp when they were applied (subset of assigned tags)","type":"object","example":{"17":"1758821945","18":"1758822131"}},"manual_tags":{"description":"Manually assigned tag IDs mapped to the Unix timestamp when they were applied (subset of assigned tags)","type":"object","example":{"19":"1759753677","20":"1758822131"}},"notification_emails_sent":{"description":"Notification email IDs mapped to the Unix timestamp when they were sent","type":"object","example":{"45":"1758821945"}},"notification_emails_opened":{"description":"Notification email IDs mapped to the Unix timestamp when they were opened","type":"object","example":{"45":"1758822131"}},"notification_emails_clicked":{"description":"Notification email IDs mapped to the Unix timestamp when they were clicked","type":"object","example":{"45":"1758822131"}},"emails_sent":{"description":"Email IDs mapped to the Unix timestamp when they were sent","type":"object","example":{"1":"1758822606","2":"1758822769"}},"emails_opened":{"description":"Email IDs mapped to the Unix timestamp when they were opened","type":"object","example":{"1":"1758822610","2":"1758884682"}},"emails_clicked":{"description":"Email IDs mapped to the Unix timestamp when they were clicked","type":"object","example":{"1":"1758822733"}},"campaigns_started":{"description":"Campaign IDs mapped to the Unix timestamp when they were started","type":"object","example":{"6":"1759753673"}},"campaigns_finished":{"description":"Campaign IDs mapped to the Unix timestamp when they were finished","type":"object","example":{"6":"1759753677"}}},"type":"object"}},"components/schemas/SubscriberUpdateSchema":{"id":"components/schemas/SubscriberUpdateSchema","kind":"json-schema","title":"SubscriberUpdateSchema","data":{"properties":{"newemail":{"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},"newsmsnumber":{"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":"+492201234567","fieldWebsite":"https://www.klicktipp.example","fieldBirthday":"755222400","fieldLeadValue":"100","field12345":"Custom Field Value"},"nullable":true,"additionalProperties":{"type":"string"}}},"type":"object"}},"components/schemas/SubscriberUnsubscribeSchema":{"id":"components/schemas/SubscriberUnsubscribeSchema","kind":"json-schema","title":"SubscriberUnsubscribeSchema","data":{"required":["email"],"properties":{"email":{"description":"Email address of the contact","type":"string","example":"alex.example@klicktipp.example"}},"type":"object"}},"components/schemas/SubscriberTagSchema":{"id":"components/schemas/SubscriberTagSchema","kind":"json-schema","title":"SubscriberTagSchema","data":{"required":["email","tagids"],"properties":{"email":{"description":"Email address of the contact","type":"string","example":"alex.example@klicktipp.example"},"tagids":{"description":"Array of tag IDs that are assigned to the contact","type":"array","items":{"type":"integer"},"example":[19,20]}},"type":"object"}},"components/schemas/SubscriberUntagSchema":{"id":"components/schemas/SubscriberUntagSchema","kind":"json-schema","title":"SubscriberUntagSchema","data":{"required":["email","tagid"],"properties":{"email":{"description":"Email address of the contact","type":"string","example":"alex.example@klicktipp.example"},"tagid":{"description":"Tag ID to remove from the contact","type":"integer","example":19}},"type":"object"}},"components/schemas/SubscriberSearchSchema":{"id":"components/schemas/SubscriberSearchSchema","kind":"json-schema","title":"SubscriberSearchSchema","data":{"required":["email"],"properties":{"email":{"description":"Email address of the contact","type":"string","example":"alex.example@klicktipp.example"}},"type":"object"}},"components/schemas/SubscriberTaggedSchema":{"id":"components/schemas/SubscriberTaggedSchema","kind":"json-schema","title":"SubscriberTaggedSchema","data":{"required":["tagid","status","bounceStatus"],"properties":{"tagid":{"description":"The ID of the tag to which the contacts belong","type":"integer","example":20},"status":{"description":"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.","type":"array","items":{"type":"string"},"example":["subscribed","pending"]},"bounceStatus":{"description":"Filter contacts by their bounce status (hardbounce, softbounce, spambounce, nobounce). If no value is selected, the filter defaults to softbounce, spambounce, and nobounce.","type":"array","items":{"type":"string"},"example":["nobounce","softbounce"]}},"type":"object"}},"components/schemas/TagCreateSchema":{"id":"components/schemas/TagCreateSchema","kind":"json-schema","title":"TagCreateSchema","data":{"required":["name"],"properties":{"name":{"description":"Name of the tag","type":"string","example":"mynewtag"},"text":{"description":"Descriptive text for the tag","type":"string","example":"hello","nullable":true}},"type":"object"}},"components/schemas/TagUpdateSchema":{"id":"components/schemas/TagUpdateSchema","kind":"json-schema","title":"TagUpdateSchema","data":{"properties":{"name":{"description":"Name of the tag","type":"string","example":"mynewtag","nullable":true},"text":{"description":"Descriptive text for the tag","type":"string","example":"hello","nullable":true}},"type":"object"}},"schema_22":{"kind":"json-schema","data":{"required":["username","password"],"properties":{"username":{"description":"The username.","type":"string","example":"{{username}}"},"password":{"description":"The password.","type":"string","format":"password","example":"{{password}}"}},"type":"object"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"properties":{"sessid":{"description":"Session ID","type":"string"},"session_name":{"description":"Session name","type":"string"},"account":{"description":"Account information","type":"object"}},"type":"object"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"Set-Cookie":{"type":"string","example":"SSESSabc=xyz123; path=/; secure; httponly;","description":"Session cookie for authentication."}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"oneOf":[{"type":"object"},{"type":"array","items":{"type":"string"}}]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string","default":"subscribed","pattern":"^(subscribed|pending|unsubscribed)(,(subscribed|pending|unsubscribed))*$"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","default":"softbounce,spambounce,nobounce","pattern":"^(hardbounce|softbounce|spambounce|nobounce)(,(hardbounce|softbounce|spambounce|nobounce))*$"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"description":"Array of contact IDs","type":"array","items":{"type":"string"}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"array","items":{"type":"boolean"},"example":[true]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"properties":{"id":{"description":"Internal ID of the tag","type":"string"},"name":{"description":"Name of the tag","type":"string"}},"type":"object"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"integer","pattern":"\\d+"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"properties":{"listid":{"description":"The ID of the opt-in process","type":"integer","example":45},"name":{"description":"The name of the opt-in process","type":"string","example":"my optin process"},"usesingleoptin":{"description":"Use single opt-in","type":"boolean","example":false},"pendingurl":{"description":"Pending url","type":"string","example":"https://mypending.com"},"thankyouurl":{"description":"Thank you url","type":"string","example":"https://mythankyou.com"},"resendconfirmationemail":{"description":"Resend confirmation email","type":"boolean","example":false},"usechangeemail":{"description":"Use change email","type":"boolean","example":false}},"type":"object"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"properties":{"tagid":{"description":"Internal ID of the tag","type":"string"},"name":{"description":"Name of the tag","type":"string"},"text":{"description":"Descriptive text for the tag","type":"string"}},"type":"object"},"id":"schema_37"}},"exampleStore":{"paths/~1account~1login/post/responses/200/content/application~1json/example":{"value":{"sessid":"xyz123","session_name":"SSESSabc","account":{"uid":1,"status":1,"tier":20,"usergroup":"42","username":"alexexample","email":"alex.example@klicktipp.example","firstname":"Alex","lastname":"Example","company":"Example Corp","country":"DE","street":"Example Street 1","city":"Berlin","state":"Berlin","zip":"10115","website":"https://www.klicktipp.example","affid":"0","phone":"00491234567890","fax":"00491234567890"}},"id":"paths/~1account~1login/post/responses/200/content/application~1json/example"},"paths/~1account~1login/post/responses/400/content/application~1json/example":{"value":["The key \"username\" must be a string."],"id":"paths/~1account~1login/post/responses/400/content/application~1json/example"},"paths/~1account~1login/post/responses/401/content/application~1json/example":{"value":["Wrong username or password."],"id":"paths/~1account~1login/post/responses/401/content/application~1json/example"},"paths/~1account~1login/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1account~1login/post/responses/406/content/application~1json/example"},"paths/~1subscriber/get/responses/200/content/application~1json/example":{"value":["123","456"],"id":"paths/~1subscriber/get/responses/200/content/application~1json/example"},"paths/~1subscriber/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber/get/responses/403/content/application~1json/example"},"paths/~1subscriber/get/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1subscriber/get/responses/404/content/application~1json/example"},"paths/~1subscriber/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber/post/responses/403/content/application~1json/example"},"paths/~1subscriber/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber/post/responses/406/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1{subscriberid}/get/responses/403/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1subscriber~1{subscriberid}/get/responses/404/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/put/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1{subscriberid}/put/responses/403/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1{subscriberid}/put/responses/406/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/delete/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1{subscriberid}/delete/responses/403/content/application~1json/example"},"paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1{subscriberid}/delete/responses/406/content/application~1json/example"},"paths/~1subscriber~1unsubscribe/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1unsubscribe/post/responses/403/content/application~1json/example"},"paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1unsubscribe/post/responses/406/content/application~1json/example"},"paths/~1subscriber~1search/post/responses/200/content/application~1json/example":{"value":[3],"id":"paths/~1subscriber~1search/post/responses/200/content/application~1json/example"},"paths/~1subscriber~1search/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1search/post/responses/403/content/application~1json/example"},"paths/~1subscriber~1search/post/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1subscriber~1search/post/responses/404/content/application~1json/example"},"paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example":{"value":{"3":"1760530436"},"id":"paths/~1subscriber~1tagged/post/responses/200/content/application~1json/example"},"paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1tagged/post/responses/403/content/application~1json/example"},"paths/~1subscriber~1tag/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1tag/post/responses/403/content/application~1json/example"},"paths/~1subscriber~1tag/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1tag/post/responses/406/content/application~1json/example"},"paths/~1subscriber~1untag/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1subscriber~1untag/post/responses/403/content/application~1json/example"},"paths/~1subscriber~1untag/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1subscriber~1untag/post/responses/406/content/application~1json/example"},"paths/~1field/get/responses/200/content/application~1json/example":{"value":{"fieldFirstName":"First name","fieldLastName":"Last name","fieldCompanyName":"Company","fieldStreet1":"Street 1","fieldStreet2":"Street 2","fieldCity":"City","fieldState":"State","fieldZip":"Zip","fieldCountry":"Country","fieldPrivatePhone":"Phone (private)","fieldMobilePhone":"Phone (mobile)","fieldPhone":"Phone","fieldFax":"Fax","fieldWebsite":"Website","fieldBirthday":"Birthday","fieldLeadValue":"Lead value","field12345":"Custom Field Name"},"id":"paths/~1field/get/responses/200/content/application~1json/example"},"paths/~1field/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1field/get/responses/403/content/application~1json/example"},"paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example":{"value":{"id":"12345","name":"Custom Field Value"},"id":"paths/~1field~1{fieldid}/get/responses/200/content/application~1json/example"},"paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1field~1{fieldid}/get/responses/403/content/application~1json/example"},"paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1field~1{fieldid}/get/responses/404/content/application~1json/example"},"paths/~1list/get/responses/200/content/application~1json/example":{"value":{"3":"","23":"my-optin-process"},"id":"paths/~1list/get/responses/200/content/application~1json/example"},"paths/~1list/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1list/get/responses/403/content/application~1json/example"},"paths/~1list~1{listid}/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1list~1{listid}/get/responses/403/content/application~1json/example"},"paths/~1list~1{listid}/get/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1list~1{listid}/get/responses/404/content/application~1json/example"},"paths/~1list~1redirect/post/responses/200/content/application~1json/example":{"value":["https://mypendingurl.com"],"id":"paths/~1list~1redirect/post/responses/200/content/application~1json/example"},"paths/~1list~1redirect/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1list~1redirect/post/responses/403/content/application~1json/example"},"paths/~1list~1redirect/post/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1list~1redirect/post/responses/404/content/application~1json/example"},"paths/~1tag/get/responses/200/content/application~1json/example":{"value":{"21":"mytag","23":"example"},"id":"paths/~1tag/get/responses/200/content/application~1json/example"},"paths/~1tag/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1tag/get/responses/403/content/application~1json/example"},"paths/~1tag/post/responses/200/content/application~1json/example":{"value":[49],"id":"paths/~1tag/post/responses/200/content/application~1json/example"},"paths/~1tag/post/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1tag/post/responses/403/content/application~1json/example"},"paths/~1tag/post/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1tag/post/responses/406/content/application~1json/example"},"paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example":{"value":{"tagid":"21","name":"mytag","text":"some text"},"id":"paths/~1tag~1{tagid}/get/responses/200/content/application~1json/example"},"paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1tag~1{tagid}/get/responses/403/content/application~1json/example"},"paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1tag~1{tagid}/get/responses/404/content/application~1json/example"},"paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1tag~1{tagid}/put/responses/403/content/application~1json/example"},"paths/~1tag~1{tagid}/put/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1tag~1{tagid}/put/responses/404/content/application~1json/example"},"paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1tag~1{tagid}/put/responses/406/content/application~1json/example"},"paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example":{"value":["API access denied."],"id":"paths/~1tag~1{tagid}/delete/responses/403/content/application~1json/example"},"paths/~1tag~1{tagid}/delete/responses/404/content/application~1json/example":{"value":["There is no such entity."],"id":"paths/~1tag~1{tagid}/delete/responses/404/content/application~1json/example"},"paths/~1tag~1{tagid}/delete/responses/406/content/application~1json/example":{"value":{"error":507},"id":"paths/~1tag~1{tagid}/delete/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":true,"hideSidebar":true,"mockServer":{"url":"/_mock/management-api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/management-api.json?download"},{"url":"/_bundle/management-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"KlickTipp API","description":"This specification describes the **KlickTipp Management API**.\n\nIt is intended for developers and integrators who want to interact directly with KlickTipp to manage contacts, tags, custom fields, opt-in processes, and automation workflows.  \nThe API can be used standalone or through third-party platforms.\n\nThe specification focuses on correct request formats, authentication mechanisms, response structures, and error handling to ensure reliable and predictable integrations.\n\n**Good to know:** \nThis API uses session-based cookie authentication. Interactive Try-It requests do not fully support this login flow.\nFor production testing click on the button to open our Collection in Postman.\n\n<div class=\"postman-run-button\"\ndata-postman-action=\"collection/fork\"\ndata-postman-visibility=\"public\"\ndata-postman-var-1=\"45081328-af33033f-f8b3-4d38-b2ce-af1b9c3b2a28\"\ndata-postman-collection-url=\"entityId=45081328-af33033f-f8b3-4d38-b2ce-af1b9c3b2a28&entityType=collection&workspaceId=c516bfec-10fe-4a61-a25e-0d5eb0361079\"></div>\n<script type=\"text/javascript\">\n  (function (p,o,s,t,m,a,n) {\n    !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });\n    !o.getElementById(s+t) && o.getElementsByTagName(\"head\")[0].appendChild((\n      (n = o.createElement(\"script\")),\n      (n.id = s+t), (n.async = 1), (n.src = m), n\n    ));\n  }(window, document, \"_pm\", \"PostmanRunObject\", \"https://run.pstmn.io/button.js\"));\n</script>\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## Getting Started\n\nTo access the API, you must authenticate and maintain a valid session.\n\n1. **Authentication**  \n   Most endpoints require cookie-based authentication.  \n   Use the login endpoint with your KlickTipp username and password to obtain a **session cookie**, which must be sent with all subsequent requests.\n\n2. **Request Preparation**  \n   Replace all placeholder values such as email addresses, IDs, or timestamps with valid test data.  \n   Invalid formats are a common source of errors.\n\n3. **Response Handling**  \n   The API returns structured payloads and numeric error codes.  \n   Always validate HTTP status codes and response bodies programmatically.\n\n---\n\n## Authentication Overview\n\nThe KlickTipp Management API supports **multiple authentication models**, depending on the integration scenario.\n\n- **Username and password authentication via session cookie**  \n  Typically used for internal tools and administrative workflows.\n\n- **Developer key and customer key authentication**  \n  Intended for long-running, production-grade, or multi-tenant integrations.  \n  This model does not rely on session handling.  \n\nDocumentation:  \n[How to authenticate and access the Management API](https://developers.klicktipp.com/guides/management-api-authentication)\n\n---\n\n## Response Format\n\nThe KlickTipp Management API uses JSON as its response format.\n\nAll endpoints return **JSON responses**, including structured data, timestamps, and error details.  \nIntegrations are expected to consume and validate JSON exclusively.\n\n---\n\n## Data Formats and Validation\n\nDate and time values must always be provided as **Unix timestamps (seconds)**.\n\nFormatted date strings, locale-specific formats, and timezone annotations are **not supported**.\n\nIncorrect field formats are a frequent cause of validation errors. \nAlways 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\n## Error Handling\n\nErrors are typically returned with **HTTP status code 406** and include a numeric error code in the response body.\n\nIntegrations should handle errors explicitly and provide meaningful diagnostics for debugging and monitoring.\n\nDocumentation:  \n[Error Handling](https://developers.klicktipp.com/guides/error-handling)\n\n---\n\nThis specification is designed to support stable, predictable, and maintainable integrations with the KlickTipp platform.\n"}},"baseSlug":"/management-api","routesMapping":{}}