{"info":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","description":"<html><head></head><body><p>The HiCandidate API lets you retrieve orders and jobs, create and update jobs, manage advertising campaigns, generate media assets, translate text, and send conversion events.</p>\n<h2 id=\"base-url\">Base URL</h2>\n<p><code>https://api.hicandidate.com</code></p>\n<h2 id=\"authentication\">Authentication</h2>\n<p>Authenticated endpoints use a Bearer token.</p>\n<p><code>Authorization: Bearer YOUR_API_TOKEN</code></p>\n<p>In this Postman collection, set the collection variable <code>API_TOKEN</code> once. Postman sends it automatically with authenticated requests.</p>\n<p>API tokens can be created in HiCandidate™ Frontend (<a href=\"https://client.hicandidate.com/\">https://client.hicandidate.com/</a>).</p>\n<h2 id=\"core-concepts\">Core concepts</h2>\n<ul>\n<li><p><strong>Order</strong>: Container for jobs. Orders can be managed by feed or via the API.</p>\n</li>\n<li><p><strong>Job</strong>: A job inside an order. A job contains general job data and can contain channel-specific campaign data.</p>\n</li>\n<li><p><strong>Campaign</strong>: Advertising configuration for a specific platform such as Meta, LinkedIn, Google or TikTok.</p>\n</li>\n</ul>\n<h2 id=\"recommended-workflow\">Recommended workflow</h2>\n<ol>\n<li><p>Call <strong>List orders</strong> and choose an API order.</p>\n</li>\n<li><p>Call <strong>List jobs</strong> or <strong>Get job</strong> to inspect existing jobs.</p>\n</li>\n<li><p>Use <strong>Create job</strong> to create a new job.</p>\n</li>\n<li><p>Use <strong>Update job</strong> or one of the campaign update requests to change only the fields you want to modify.</p>\n</li>\n<li><p>Use <strong>Pause all campaigns</strong> if all campaigns of a job should be paused.</p>\n</li>\n</ol>\n<h2 id=\"update-semantics\">Update semantics</h2>\n<p>Updates are documented with <code>PATCH</code>. Send only the properties that should change. Properties omitted from the request remain unchanged.</p>\n<h2 id=\"response-format\">Response format</h2>\n<p>Most endpoints return JSON in the following envelope:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"success\": true,\n  \"data\": {}\n}\n\n</code></pre>\n<p>If <code>success</code> is <code>false</code>, <code>data</code> contains an error description.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"590402","collectionId":"55d54b8c-5d85-4c83-9311-8192b98258c6","publishedId":"2sBYB4L6ZW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"66b041"},"publishDate":"2026-09-28T14:16:59.000Z"},"item":[{"name":"Getting started","item":[{"name":"API status","event":[{"listen":"prerequest","script":{"exec":["",""],"type":"text/javascript","packages":{},"id":"3f5e4e39-a63d-40a9-99fc-9b2add9f9751"}}],"id":"00997cb6-da3b-4d1f-b097-5d3becbc5241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/status","description":"<p>Checks whether the HiCandidate API service is reachable. No authentication is required.</p>\n","urlObject":{"path":["status"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"0fb912df-b674-43be-b924-84e224f0d9d7","name":"Success","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":"https://api.hicandidate.com/status","description":"Checks whether the HiCandidate API service is reachable. No authentication is required."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"online\"\n}"}],"_postman_id":"00997cb6-da3b-4d1f-b097-5d3becbc5241"}],"id":"6aa8255e-f819-4302-bc44-8b44a0fc764b","description":"<p>Start here to verify service availability and understand the basic API setup.</p>\n","_postman_id":"6aa8255e-f819-4302-bc44-8b44a0fc764b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}},{"name":"Orders","item":[{"name":"List orders","id":"aa2fc9a7-cdca-4f1d-881b-ad584e0f44c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hicandidate.com/v1/orders","description":"<p>Returns all orders available to the authenticated client.</p>\n<p>Use this endpoint first to find the <code>order_id</code> required by the job endpoints.</p>\n<h3 id=\"important\">Important</h3>\n<p>Only orders available to the authenticated client are returned. An order has an <code>order_type</code>; job changes through the API are allowed only for orders of type <code>API</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"ba54429e-88d8-4cda-be06-71741ea667dd","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.hicandidate.com/v1/orders","description":"Returns all orders available to the authenticated client.\n\nUse this endpoint first to find the `order_id` required by the job endpoints.\n\n### Important\nOnly orders available to the authenticated client are returned. An order has an `order_type`; job changes through the API are allowed only for orders of type `API`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"name\": \"TEST ORDER\",\n      \"order_type\": \"API\",\n      \"max_jobs\": 300\n    }\n  ]\n}"}],"_postman_id":"aa2fc9a7-cdca-4f1d-881b-ad584e0f44c7"}],"id":"f1690b7f-5f79-46e2-a424-5dfabd06f237","description":"<p>Retrieve the orders available to the authenticated client.</p>\n","_postman_id":"f1690b7f-5f79-46e2-a424-5dfabd06f237","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}},{"name":"Jobs","item":[{"name":"List jobs","id":"b39a4f70-2e05-4083-9436-8250395ee36e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hicandidate.com/v1/orders/1/jobs","description":"<p>Returns jobs for the selected order.</p>\n<h3 id=\"default-time-filter\">Default time filter</h3>\n<p>If <code>created_after</code> is not provided, only jobs created within the last 180 days are returned.</p>\n<h3 id=\"filtering\">Filtering</h3>\n<p>All query parameters are optional. Enable only the filters you need in Postman. Multiple filters are combined.</p>\n<h3 id=\"response\">Response</h3>\n<p>Each entry contains a <code>job</code> object and, where available, channel-specific objects such as <code>platform_meta</code>, <code>platform_linkedin</code>, <code>platform_google</code> or <code>platform_tiktok</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs"],"host":["https://api.hicandidate.com"],"query":[{"disabled":true,"description":{"content":"<p>Exact match on the job reference ID.</p>\n","type":"text/plain"},"key":"reference_id","value":"123wasdf1233344777"},{"disabled":true,"description":{"content":"<p>Filter by HiCandidate job ID.</p>\n","type":"text/plain"},"key":"job_id","value":"123456"},{"disabled":true,"description":{"content":"<p>Return jobs created after this date. Format: YYYY-MM-DD. If omitted, the API defaults to jobs created within the last 180 days.</p>\n","type":"text/plain"},"key":"created_after","value":"2026-01-01"},{"disabled":true,"description":{"content":"<p>Return jobs created before this date. Format: YYYY-MM-DD.</p>\n","type":"text/plain"},"key":"created_before","value":"2026-12-31"},{"disabled":true,"description":{"content":"<p>Substring search in the job title.</p>\n","type":"text/plain"},"key":"title","value":"Account Manager"},{"disabled":true,"description":{"content":"<p>Substring search in the job location.</p>\n","type":"text/plain"},"key":"location","value":"Stuttgart"},{"disabled":true,"description":{"content":"<p>Substring search in the job description.</p>\n","type":"text/plain"},"key":"description","value":"Sales"}],"variable":[]}},"response":[{"id":"025140ff-b632-4784-bb77-c8a2e443b99f","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hicandidate.com/v1/orders/1/jobs","host":["https://api.hicandidate.com"],"path":["v1","orders","1","jobs"],"query":[{"key":"reference_id","value":"123wasdf1233344777","description":"Exact match on the job reference ID.","disabled":true},{"key":"job_id","value":"123456","description":"Filter by HiCandidate job ID.","disabled":true},{"key":"created_after","value":"2026-01-01","description":"Return jobs created after this date. Format: YYYY-MM-DD. If omitted, the API defaults to jobs created within the last 180 days.","disabled":true},{"key":"created_before","value":"2026-12-31","description":"Return jobs created before this date. Format: YYYY-MM-DD.","disabled":true},{"key":"title","value":"Account Manager","description":"Substring search in the job title.","disabled":true},{"key":"location","value":"Stuttgart","description":"Substring search in the job location.","disabled":true},{"key":"description","value":"Sales","description":"Substring search in the job description.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"job\": {\n        \"id\": 100744,\n        \"title\": \"Account Manager (m/w/d)\",\n        \"order_id\": 1,\n        \"reference_id\": \"12345678901\",\n        \"description\": \"\",\n        \"location\": \"DE, 70170 Stuttgart\",\n        \"performance\": {},\n        \"created_at\": \"2026-01-01 12:00:00\"\n      },\n      \"platform_meta\": {\n        \"status\": \"PAUSED\"\n      }\n    }\n  ]\n}"}],"_postman_id":"b39a4f70-2e05-4083-9436-8250395ee36e"},{"name":"Get job","id":"a893ea1f-700f-4cd0-8b13-349654ba1bc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hicandidate.com/v1/orders/1/jobs?job_id=123456","description":"<p>Returns one job by HiCandidate job ID.</p>\n<p>This endpoint uses the existing jobs listing endpoint with the <code>job_id</code> filter.</p>\n<h3 id=\"path-variable\">Path variable</h3>\n<p><code>ORDER_ID</code> must be the order containing the job.</p>\n<h3 id=\"query-parameter\">Query parameter</h3>\n<p><code>job_id</code> is the HiCandidate job ID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs"],"host":["https://api.hicandidate.com"],"query":[{"description":{"content":"<p>HiCandidate job ID.</p>\n","type":"text/plain"},"key":"job_id","value":"123456"}],"variable":[]}},"response":[{"id":"a99e3550-417f-4cce-87ab-237745f898d2","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hicandidate.com/v1/orders/1/jobs?job_id=123456","host":["https://api.hicandidate.com"],"path":["v1","orders","1","jobs"],"query":[{"key":"job_id","value":"123456","description":"HiCandidate job ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"success\": true,\n    \"data\": [\n        {\n            \"job\": {\n                \"id\": 1,\n                \"title\": \"Testjob (m/w/d)\",\n                \"order_id\": 1,\n                \"reference_id\": \"123456\",\n                \"description\": \"\",\n                \"location\": \"DE, 70176 Stuttgart\",\n                \"performance\": {\n                    \"2022-06-04\": {\n                        \"google\": {\n                            \"costs\": 51.70801713,\n                            \"leads\": 0,\n                            \"clicks\": 55,\n                            \"conversions\": 0,\n                            \"impressions\": 454\n                        }\n                    },\n                    \"2022-07-17\": {\n                        \"linkedin\": {\n                            \"costs\": 19.04595,\n                            \"leads\": 0,\n                            \"clicks\": 7,\n                            \"conversions\": 0,\n                            \"impressions\": 158\n                        }\n                    },\n                    \"2022-07-18\": {\n                        \"linkedin\": {\n                            \"costs\": 17.659950000000002,\n                            \"leads\": 0,\n                            \"clicks\": 4,\n                            \"conversions\": 0,\n                            \"impressions\": 192\n                        }\n                    },\n                    \"2022-07-28\": {\n                        \"facebook\": {\n                            \"costs\": 7.21,\n                            \"leads\": 0,\n                            \"clicks\": 1,\n                            \"conversions\": 0,\n                            \"impressions\": 467\n                        },\n                        \"instagram\": {\n                            \"costs\": 2.33,\n                            \"leads\": 0,\n                            \"clicks\": 1,\n                            \"conversions\": 0,\n                            \"impressions\": 102\n                        }\n                    },\n                    \"2022-07-29\": {\n                        \"facebook\": {\n                            \"costs\": 7.35,\n                            \"leads\": 0,\n                            \"clicks\": 0,\n                            \"conversions\": 0,\n                            \"impressions\": 454\n                        },\n                        \"instagram\": {\n                            \"costs\": 2.16,\n                            \"leads\": 0,\n                            \"clicks\": 0,\n                            \"conversions\": 0,\n                            \"impressions\": 136\n                        }\n                    },\n                    \"2022-07-30\": {\n                        \"facebook\": {\n                            \"costs\": 5.188085,\n                            \"leads\": 0,\n                            \"clicks\": 0,\n                            \"conversions\": 0,\n                            \"impressions\": 213\n                        },\n                        \"instagram\": {\n                            \"costs\": 1.674894,\n                            \"leads\": 0,\n                            \"clicks\": 0,\n                            \"conversions\": 0,\n                            \"impressions\": 80\n                        }\n                    }\n                },\n                \"lead_email\": \"\",\n                \"created_at\": \"2026-09-04 21:58:15.718595\"\n            },\n            \"platform_google\": {\n                \"status\": \"ACTIVE\",\n                \"ad_type\": \"CLICK_AD\",\n                \"image_squared\": \"https://production-banners.s3-eu-west-1.amazonaws.com/sqared1234.png\",\n                \"image_horizontal\": \"https://production-banners.s3-eu-west-1.amazonaws.com/hori1234.png\",\n                \"video_url\": \"https://img.hicandidate.com/horiz_Vid.mp4\",\n                \"daily_budget\": 10,\n                \"promoted_url\": \"https://www.socialtelligence.io/\",\n                \"start_date\": \"2022-08-08\",\n                \"end_date\": \"2022-08-15\",\n                \"locations\": [\n                    {\n                        \"country\": \"DE\"\n                    },\n                    {\n                        \"country\": \"IT\"\n                    }\n                ],\n                \"ad_headline\": \"\",\n                \"ad_long_headline\": \"\",\n                \"ad_description\": \"\",\n                \"ad_business_name\": \"socialtelligence\",\n                \"ad_cta_text\": \"Jetzt bewerben\",\n                \"keywords\": \"[]\"\n            },\n            \"platform_linkedin\": {\n                \"status\": \"PAUSED\",\n                \"ad_type\": \"CLICK_AD\",\n                \"image_url\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared12334.png\",\n                \"video_url\": \"https://img.hicandidate.com/squared_vid.mp4\",\n                \"daily_budget\": 11,\n                \"ad_text\": \"Wir suchen Sie als Testjob (m/w/d) in Stuttgart.\",\n                \"ad_title\": \"Testjob (m/w/d)\",\n                \"promoted_url\": \"https://www.hicandidate.com/\",\n                \"start_date\": \"2026-08-04\",\n                \"end_date\": \"2026-08-10\",\n                \"cta_button_type\": \"APPLY\",\n                \"costs_cap\": 0,\n                \"language\": \"de\",\n                \"skill_list\": \"[]\",\n                \"locations\": [\n                    {\n                        \"zip\": \"70619\",\n                        \"city\": \"Stuttgart\",\n                        \"state\": \"Baden-Württemberg\",\n                        \"country\": \"DE\"\n                    }\n                ]\n            },\n            \"platform_meta\": {\n                \"status\": \"PAUSED\",\n                \"ad_type\": \"CONVERSION_AD\",\n                \"ad_text\": \"Starte jetzt deinen neuen Job als Testjob (M/W/D) bei socialtelligence GmbH in Stuttgart.\",\n                \"ad_title\": \"Testjob (M/W/D)\",\n                \"daily_budget\": 15,\n                \"promoted_url\": \"https://www.socialtelligence.io/bewerben/123\",\n                \"image_squared\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared1234.png\",\n                \"image_horizontal\": \"https://production-banners.s3-eu-west-1.amazonaws.com/hori123.png\",\n                \"image_vertical\": \"https://production-banners.s3-eu-west-1.amazonaws.com/vertical123.png\",\n                \"video_squared\": \"\",\n                \"video_horizontal\": \"\",\n                \"video_vertical\": \"\",\n                \"cta_button_type\": \"LEARN_MORE\",\n                \"ad_text_sub\": \"Stuttgart\",\n                \"start_date\": \"2022-12-01\",\n                \"end_date\": \"2022-12-11\",\n                \"locations\": [\n                    {\n                        \"city\": \"Stuttgart\",\n                        \"zip\": \"70176\",\n                        \"state\": \"Baden-Württemberg\",\n                        \"country\": \"DE\"\n                    }\n                ],\n                \"platforms\": \"ALL\",\n                \"lead_ad_context_card_title\": \"\",\n                \"lead_ad_context_card_content\": \"\",\n                \"lead_ad_question_page_custom_headline\": \"\",\n                \"lead_ad_questions\": \"\",\n                \"lead_ad_privacy_policy_url\": \"\",\n                \"lead_ad_privacy_policy_link_text\": \"\",\n                \"lead_ad_is_optimized_for_quality\": \"\",\n                \"lead_ad_thank_you_page_title\": \"\",\n                \"lead_ad_thank_you_page_body\": \"\",\n                \"lead_ad_thank_you_page_button_text\": \"\",\n                \"lead_ad_thank_you_page_website_url\": \"\"\n            }\n        }\n    ]\n}"}],"_postman_id":"a893ea1f-700f-4cd0-8b13-349654ba1bc3"},{"name":"Create job","id":"1a1bc52a-182f-4ba7-8642-e68bcfc84b37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"job\": {\n        \"title\": \"Account Manager (m/w/d)\",\n        \"reference_id\": \"12345678901\",\n        \"description\": \"\",\n        \"full_description\": \"\",\n        \"location\": \"DE, 70170 Stuttgart\",\n        \"lead_email\": \"\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs","description":"<p>Creates a new job inside an API order.</p>\n<h3 id=\"before-you-start\">Before you start</h3>\n<ul>\n<li><code>ORDER_ID</code> must reference an existing order of type <code>API</code>.</li>\n<li>The request body must contain a <code>job</code> object.</li>\n<li><code>job.title</code> and <code>job.reference_id</code> are required by the current implementation.</li>\n<li><code>job.reference_id</code> should be a unique identifier from your source system.</li>\n</ul>\n<h3 id=\"example-body\">Example body</h3>\n<p>The request body in this collection contains a minimal job example. Additional supported job and platform fields are documented below.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<h4 id=\"jobtitle\">job.title</h4>\n<p>Job title. Only used in frontend.</p>\n<h4 id=\"jobreference_id\">job.reference_id</h4>\n<p>Unique String. Job reference ID e.g. 'xyz123'</p>\n<h4 id=\"jobdescription\">job.description</h4>\n<p>Job description.</p>\n<h4 id=\"joblocation\">job.location</h4>\n<p>Only used in frontend.</p>\n<h4 id=\"joblead_email\">job.lead_email</h4>\n<p>Email address for the leads e.g. '<a href=\"mailto:w.schmidt@socialtelligence.io\">w.schmidt@socialtelligence.io</a>'</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"cad60897-f730-44e7-9e8e-20aeff29d4c5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"job\": {\n        \"title\": \"Account Manager (m/w/d)\",\n        \"reference_id\": \"12345678901\",\n        \"description\": \"\",\n        \"full_description\": \"\",\n        \"location\": \"DE, 70170 Stuttgart\",\n        \"lead_email\": \"\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs","description":"Creates a new job inside an API order.\n\n### Before you start\n- `ORDER_ID` must reference an existing order of type `API`.\n- The request body must contain a `job` object.\n- `job.title` and `job.reference_id` are required by the current implementation.\n- `job.reference_id` should be a unique identifier from your source system.\n\n### Example body\nThe request body in this collection contains a minimal job example. Additional supported job and platform fields are documented below.\n\n### Parameters\n\n#### job.title\n\nJob title. Only used in frontend.\n\n#### job.reference_id\n\nUnique String. Job reference ID e.g. 'xyz123'\n\n#### job.description\n\nJob description.\n\n#### job.location\n\nOnly used in frontend.\n\n#### job.lead_email\n\nEmail address for the leads e.g. 'w.schmidt@socialtelligence.io'"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"123456\"\n}"}],"_postman_id":"1a1bc52a-182f-4ba7-8642-e68bcfc84b37"},{"name":"Update job","id":"550e3328-a2f7-46c4-9a25-ddd7e9269e42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"job\": {\n        \"title\": \"Key Account Manager (M/W/X)\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Updates selected properties of an existing job.</p>\n<h3 id=\"patch-behavior\">PATCH behavior</h3>\n<p>Send only the fields that should change. Fields that are not included remain unchanged.</p>\n<h3 id=\"important\">Important</h3>\n<ul>\n<li><code>job.reference_id</code> is read-only and cannot be changed.</li>\n<li><code>ORDER_ID</code> must belong to the authenticated client.</li>\n<li><code>JOB_ID</code> must identify a job belonging to that client.</li>\n<li>Changes are allowed only for orders of type <code>API</code>.</li>\n</ul>\n<h3 id=\"example\">Example</h3>\n<p>The included body changes only the job title.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"11797bd2-2eff-480e-af9e-22153aa74807","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"job\": {\n        \"title\": \"Key Account Manager (M/W/X)\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"Updates selected properties of an existing job.\n\n### PATCH behavior\nSend only the fields that should change. Fields that are not included remain unchanged.\n\n### Important\n- `job.reference_id` is read-only and cannot be changed.\n- `ORDER_ID` must belong to the authenticated client.\n- `JOB_ID` must identify a job belonging to that client.\n- Changes are allowed only for orders of type `API`.\n\n### Example\nThe included body changes only the job title."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"ok\"\n}"}],"_postman_id":"550e3328-a2f7-46c4-9a25-ddd7e9269e42"},{"name":"Pause all campaigns","id":"d1265850-71e8-46f0-aeec-cb28990635ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Pauses all advertising campaigns associated with the selected job across all configured platforms.</p>\n<p>The job itself is not deleted. Existing campaign data remains available and campaigns can later be activated again through a platform update request.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"eda6c526-1efa-4dd2-a500-2f09e55696f9","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"Pauses all advertising campaigns associated with the selected job across all configured platforms.\n\nThe job itself is not deleted. Existing campaign data remains available and campaigns can later be activated again through a platform update request."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"Campaigns of 123456 have been paused.\"\n}"}],"_postman_id":"d1265850-71e8-46f0-aeec-cb28990635ef"}],"id":"43cec094-117b-415f-a666-17683c1cdf13","description":"<p>Retrieve, create and update jobs. Job updates use PATCH and modify only the supplied fields.</p>\n","_postman_id":"43cec094-117b-415f-a666-17683c1cdf13","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}},{"name":"Campaigns","item":[{"name":"Update Meta campaign","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\n"]}}],"id":"b21538e9-1580-4b6b-b30e-bdbc7490042c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_meta\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CONVERSION_AD\",\n        \"ad_text\": \"Starte jetzt deinen neuen Job als Account Manager (m/w/d) bei socialtelligence GmbH in Stuttgart.\",\n        \"ad_title\": \"Account Manager (m/w/d)\",\n        \"daily_budget\": 15,\n        \"max_bid\": 0,\n        \"promoted_url\": \"https://www.socialtelligence.io/bewerben/123\",\n        \"image_squared\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared.png\",\n        \"image_horizontal\": \"https://production-banners.s3-eu-west-1.amazonaws.com/horizontal.png\",\n        \"image_vertical\": \"\",\n        \"video_squared\": \"\", \n        \"video_horizontal\": \"\", \n        \"video_vertical\": \"\",\n        \"cta_button_type\": \"LEARN_MORE\", \n        \"ad_text_sub\": \"Stuttgart\", \n        \"start_date\": \"2026-12-01\",\n        \"end_date\": \"2026-12-11\",\n        \"locations\": [\n            {\n                \"city\": \"Stuttgart\",\n                \"zip\": \"70176\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ],\n        \"platforms\": \"ALL\", \n        \"lead_ad_context_card_title\": \"\", \n        \"lead_ad_context_card_content\": \"\",\n        \"lead_ad_question_page_custom_headline\": \"\", \n        \"lead_ad_questions\": \"\",\n        \"lead_ad_privacy_policy_url\": \"\", \n        \"lead_ad_privacy_policy_link_text\": \"\",\n        \"lead_ad_is_optimized_for_quality\": \"\", \n        \"lead_ad_thank_you_page_title\": \"\",\n        \"lead_ad_thank_you_page_body\": \"\", \n        \"lead_ad_thank_you_page_button_text\": \"\",\n        \"lead_ad_thank_you_page_website_url\": \"\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Updates or creates the platform_meta campaign configuration for an existing job.</p>\n<h3 id=\"patch-behavior\">PATCH behavior</h3>\n<p>Send only the <code>platform_meta</code> fields you want to change. Existing values not included in the request remain unchanged. If no campaign exists yet, the supplied platform data can be used to create it.</p>\n<h3 id=\"campaign-status\">Campaign status</h3>\n<p>Use <code>ACTIVE</code> to activate/create a campaign and <code>PAUSED</code> to keep or set it paused.</p>\n<h3 id=\"endpoint\">Endpoint</h3>\n<p>This uses the same job update endpoint as <strong>Update job</strong>. The platform object in the JSON body determines which campaign is changed.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<h4 id=\"platform_metastatus\">platform_meta.status</h4>\n<p>'platform_meta.status' should be one of the following: 'ACTIVE' or 'PAUSED'</p>\n<h4 id=\"platform_metaad_type\">platform_meta.ad_type</h4>\n<p>'platform_meta.ad_type' should be one of the following: 'CLICK_AD', 'CONVERSION_AD' or 'LEAD_AD'</p>\n<h4 id=\"platform_metaad_text\">platform_meta.ad_text</h4>\n<p>'platform_meta.ad_text' length should be &gt; 0 and &lt;=2000 characters.</p>\n<h4 id=\"platform_metaad_title\">platform_meta.ad_title</h4>\n<p>'platform_meta.ad_text' appears under the image/video and is about 40 characters long. Max length is 1000. Min length is 1.</p>\n<h4 id=\"platform_metadaily_budget\">platform_meta.daily_budget</h4>\n<p>'platform_meta.daily_budget' should be numeric for instance 17.50 (CLICK_AD: &gt;= 5 and &lt;= 200, CONVERSION_AD/LEAD_AD: &gt;= 10 and &lt;= 300)</p>\n<h4 id=\"platform_metamax_bid\">platform_meta.max_bid</h4>\n<p>'platform_meta.max_bid' have to be numeric for instance 2.00. Set to 0 for automatic (recommended)</p>\n<h4 id=\"platform_metapromoted_url\">platform_meta.promoted_url</h4>\n<p>'platform_meta.promoted_url' starts with 'http://' or 'https://'. Can not be more than 2000 characters.</p>\n<h4 id=\"platform_metaimage_squared\">platform_meta.image_squared</h4>\n<p>'platform_meta.image_squared' not valid. Example: '<a href=\"https://www.hicandidate/image001.png'\">https://www.hicandidate/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000.</p>\n<h4 id=\"platform_metaimage_horizontal\">platform_meta.image_horizontal</h4>\n<p>'platform_meta.image_horizontal' not valid. Example: '<a href=\"https://www.hicandidate/image001.png'\">https://www.hicandidate/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000. Horizontal image ist not optional, if there is no video media.</p>\n<h4 id=\"platform_metaimage_vertical\">platform_meta.image_vertical</h4>\n<p>'platform_meta.image_vertical' not valid. Example: '<a href=\"https://www.hicandidate/image001.png'\">https://www.hicandidate/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000.</p>\n<h4 id=\"platform_metavideo_squared\">platform_meta.video_squared</h4>\n<p>'platform_meta.video_squared'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000. The video must be at least 500px in height and width. Suggestion: w:1000 x h:1000px. Use image_squared as thumbnail image.</p>\n<h4 id=\"platform_metavideo_horizontal\">platform_meta.video_horizontal</h4>\n<p>'platform_meta.video_horizontal'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000. The video must be at least 500px in height and width. Suggestion: w:1280 x h:720px. Use image_horizontal as thumbnail image.</p>\n<h4 id=\"platform_metavideo_vertical\">platform_meta.video_vertical</h4>\n<p>'platform_meta.video_vertical'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000. The video must be at least 500px in height and width. Suggestion: w:1080 x h:1920px. Use image_vertical as thumbnail image.</p>\n<h4 id=\"platform_metacta_button_type\">platform_meta.cta_button_type</h4>\n<p>'platform_meta.cta_button_type' should be one of the following: 'APPLY_NOW', 'LEARN_MORE'</p>\n<h4 id=\"platform_metaad_text_sub\">platform_meta.ad_text_sub</h4>\n<p>'platform_meta.ad_text_sub' appears under the ad_title and is about 30 characters long. Max length is 1000. Min length is 1.</p>\n<h4 id=\"platform_metastart_date\">platform_meta.start_date</h4>\n<p>'platform_meta.start_date' not valid. Example: '2022-07-12'. Format: YYYY-MM-DD</p>\n<h4 id=\"platform_metaend_date\">platform_meta.end_date</h4>\n<p>'platform_meta.end_date' example: '2022-07-12'. Format: YYYY-MM-DD. This date defines the last day for the ads run time. This date is included to the run time of the ad.</p>\n<h4 id=\"platform_metalocations\">platform_meta.locations</h4>\n<p>'platform_meta.locations': Valid example: [ {'city': 'Stuttgart', 'zip': '70619', 'state': 'Baden-Württemberg', 'country': 'DE', 'coords': {'latitude': 48.7430149, 'longitude': 9.2150882} } ]. Country is a 2 characters code (ISO 3166-1 alpha-2).</p>\n<h4 id=\"platform_metaplatforms\">platform_meta.platforms</h4>\n<p>'platform_meta.platforms' should be one of the following: 'facebook', 'instagram' or 'ALL'</p>\n<h4 id=\"platform_metalead_ad_context_card_title\">platform_meta.lead_ad_context_card_title</h4>\n<p>'platform_meta.lead_ad_context_card_title'. Set to '' if not needed. Max length is 60.</p>\n<h4 id=\"platform_metalead_ad_context_card_content\">platform_meta.lead_ad_context_card_content</h4>\n<p>'platform_meta.lead_ad_context_card_content'. Only optional if 'platform_meta.lead_ad_context_card_title' is ''. Max length is 1000.</p>\n<h4 id=\"platform_metalead_ad_question_page_custom_headline\">platform_meta.lead_ad_question_page_custom_headline</h4>\n<p>'platform_meta.lead_ad_question_page_custom_headline'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Max length is 1000.</p>\n<h4 id=\"platform_metalead_ad_questions\">platform_meta.lead_ad_questions</h4>\n<p>'platform_meta.lead_ad_questions'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Should be a valid JSON-formatted string. Example: [{'type': 'EMAIL'}, {'type': 'FULL_NAME'}, {'type': 'PHONE'}, {'type': 'CUSTOM', 'label': 'Besitzen Sie einen Führerschein der Klasse B?', 'options': [{'value': 'Ja', 'key': 'Ja'}, {'value': 'Nein', 'key': 'Nein'}]}]</p>\n<h4 id=\"platform_metalead_ad_privacy_policy_url\">platform_meta.lead_ad_privacy_policy_url</h4>\n<p>'platform_meta.lead_ad_privacy_policy_url'. Example: '<a href=\"https://www.hicandidate.com/datenschutz'\">https://www.hicandidate.com/datenschutz'</a>. Must start with 'http://' or 'https://'. Max length 2000.</p>\n<h4 id=\"platform_metalead_ad_privacy_policy_link_text\">platform_meta.lead_ad_privacy_policy_link_text</h4>\n<p>'platform_meta.lead_ad_privacy_policy_link_text'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Max length is 70.</p>\n<h4 id=\"platform_metalead_ad_is_optimized_for_quality\">platform_meta.lead_ad_is_optimized_for_quality</h4>\n<p>'platform_meta.lead_ad_is_optimized_for_quality'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Possible values are 'true' or 'false'.</p>\n<h4 id=\"platform_metalead_ad_thank_you_page_title\">platform_meta.lead_ad_thank_you_page_title</h4>\n<p>'platform_meta.lead_ad_thank_you_page_title'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Max length is 60.</p>\n<h4 id=\"platform_metalead_ad_thank_you_page_body\">platform_meta.lead_ad_thank_you_page_body</h4>\n<p>'platform_meta.lead_ad_thank_you_page_body'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Max length is 1000.</p>\n<h4 id=\"platform_metalead_ad_thank_you_page_button_text\">platform_meta.lead_ad_thank_you_page_button_text</h4>\n<p>'platform_meta.lead_ad_thank_you_page_button_text'. Only optional if 'platform_meta.ad_type' != 'LEAD_AD'. Max length is 60.</p>\n<h4 id=\"platform_metalead_ad_thank_you_page_website_url\">platform_meta.lead_ad_thank_you_page_website_url</h4>\n<p>'platform_meta.lead_ad_thank_you_page_website_url'. Example: '<a href=\"https://www.hicandidate.com/'\">https://www.hicandidate.com/'</a>. Must start with 'http://' or 'https://'. Max length 2000.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"e16ac4b0-4473-4e70-b62e-604bb934b4c1","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_meta\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CONVERSION_AD\",\n        \"ad_text\": \"Starte jetzt deinen neuen Job als Account Manager (m/w/d) bei socialtelligence GmbH in Stuttgart.\",\n        \"ad_title\": \"Account Manager (m/w/d)\",\n        \"daily_budget\": 15,\n        \"max_bid\": 0,\n        \"promoted_url\": \"https://www.socialtelligence.io/bewerben/123\",\n        \"image_squared\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared1234.png\",\n        \"image_horizontal\": \"https://production-banners.s3-eu-west-1.amazonaws.com/horizontal.png\",\n        \"image_vertical\": \"\",\n        \"video_squared\": \"\", \n        \"video_horizontal\": \"\", \n        \"video_vertical\": \"\",\n        \"cta_button_type\": \"LEARN_MORE\", \n        \"ad_text_sub\": \"Stuttgart\", \n        \"start_date\": \"2026-12-01\",\n        \"end_date\": \"2026-12-11\",\n        \"locations\": [\n            {\n                \"city\": \"Stuttgart\",\n                \"zip\": \"70176\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ],\n        \"platforms\": \"ALL\", \n        \"lead_ad_context_card_title\": \"\", \n        \"lead_ad_context_card_content\": \"\",\n        \"lead_ad_question_page_custom_headline\": \"\", \n        \"lead_ad_questions\": \"\",\n        \"lead_ad_privacy_policy_url\": \"\", \n        \"lead_ad_privacy_policy_link_text\": \"\",\n        \"lead_ad_is_optimized_for_quality\": \"\", \n        \"lead_ad_thank_you_page_title\": \"\",\n        \"lead_ad_thank_you_page_body\": \"\", \n        \"lead_ad_thank_you_page_button_text\": \"\",\n        \"lead_ad_thank_you_page_website_url\": \"\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"ok\"\n}"}],"_postman_id":"b21538e9-1580-4b6b-b30e-bdbc7490042c"},{"name":"Update LinkedIn campaign","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\n"]}}],"id":"acfeb1d9-d2e0-4246-a417-450b57fa8f18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_linkedin\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_url\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared1234.png\",\n        \"video_url\": \"https://videos.hicandidate.com/test.mp4\",\n        \"daily_budget\": 11,\n        \"ad_text\": \"Starte jetzt deinen neuen Job als Account Manager (M/W/D) bei socialtelligence GmbH in Stuttgart.\",\n        \"ad_title\": \"Account Manager (m/w/d)\",\n        \"promoted_url\": \"https://www.hicandidate.com/\",\n        \"start_date\": \"2026-08-04\",\n        \"end_date\": \"2026-12-10\",\n        \"cta_button_type\": \"APPLY\",\n        \"costs_cap\": 0,\n        \"language\": \"de\",\n        \"skill_list\": \"[]\",\n        \"locations\": [\n            {\n                \"zip\": \"70619\",\n                \"city\": \"Stuttgart\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Updates or creates the platform_linkedin campaign configuration for an existing job.</p>\n<h3 id=\"patch-behavior\">PATCH behavior</h3>\n<p>Send only the <code>platform_linkedin</code> fields you want to change. Existing values not included in the request remain unchanged. If no campaign exists yet, the supplied platform data can be used to create it.</p>\n<h3 id=\"campaign-status\">Campaign status</h3>\n<p>Use <code>ACTIVE</code> to activate/create a campaign and <code>PAUSED</code> to keep or set it paused.</p>\n<h3 id=\"endpoint\">Endpoint</h3>\n<p>This uses the same job update endpoint as <strong>Update job</strong>. The platform object in the JSON body determines which campaign is changed.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<h4 id=\"platform_linkedinstatus\">platform_linkedin.status</h4>\n<p>'platform_linkedin.status' should be one of the following: 'ACTIVE' or 'PAUSED'</p>\n<h4 id=\"platform_linkedinad_type\">platform_linkedin.ad_type</h4>\n<p>'platform_linkedin.ad_type' should be one of the following: 'CLICK_AD', 'CONVERSION_AD' or 'LEAD_AD'</p>\n<h4 id=\"platform_linkedinimage_url\">platform_linkedin.image_url</h4>\n<p>'platform_linkedin.image_url' not valid. Example: '<a href=\"https://img.hicandidate.com/jobiq/image001.png'\">https://img.hicandidate.com/jobiq/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000. Optional if 'video_url' given.</p>\n<h4 id=\"platform_linkedinvideo_url\">platform_linkedin.video_url</h4>\n<p>'platform_linkedin.video_url'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000. The video must be at least 500px in height and width. Suggestion: w:1280 x h:720px. Video must have aspect ratio value between 0.5625 and 1.7777778.</p>\n<h4 id=\"platform_linkedindaily_budget\">platform_linkedin.daily_budget</h4>\n<p>'platform_linkedin.daily_budget' have to be numeric for instance 20.00 and &gt;= 10.0 and &lt;= 200.0</p>\n<h4 id=\"platform_linkedinad_text\">platform_linkedin.ad_text</h4>\n<p>'platform_linkedin.ad_text' length should be &gt; 0 and &lt;=600 characters.</p>\n<h4 id=\"platform_linkedinad_title\">platform_linkedin.ad_title</h4>\n<p>'platform_linkedin.ad_title' length should be &gt; 0 and &lt;=200 characters.</p>\n<h4 id=\"platform_linkedinpromoted_url\">platform_linkedin.promoted_url</h4>\n<p>'platform_linkedin.promoted_url' starts with 'http://' or 'https://'. Max. 2000 characters.</p>\n<h4 id=\"platform_linkedinstart_date\">platform_linkedin.start_date</h4>\n<p>'platform_linkedin.start_date'. Example: '2022-07-12'. Format: YYYY-MM-DD</p>\n<h4 id=\"platform_linkedinend_date\">platform_linkedin.end_date</h4>\n<p>'platform_linkedin.end_date'. Example: '2022-07-19'. Format: YYYY-MM-DD. This date defines the last day for the ads run time. This date is included to the run time of the ad.</p>\n<h4 id=\"platform_linkedincta_button_type\">platform_linkedin.cta_button_type</h4>\n<p>'platform_linkedin.cta_button_type' should be one of the following: 'APPLY', 'LEARN_MORE'</p>\n<h4 id=\"platform_linkedincosts_cap\">platform_linkedin.costs_cap</h4>\n<p>'platform_linkedin.costs_cap'. Maximum costs per click, lead or conversion. FLOAT, for instance 20.00. Max: 200, Set to 0 for no cap (recommended for best optimization).</p>\n<h4 id=\"platform_linkedinlanguage\">platform_linkedin.language</h4>\n<p>'platform_linkedin.ad_type' should be one of the following: 'de', 'en', 'fr', 'it', 'es'</p>\n<h4 id=\"platform_linkedinskill_list\">platform_linkedin.skill_list</h4>\n<p>'platform_linkedin.skill_list'. String list e.g. ['html', 'css', 'marketing']. Leave it empty (\"[]\") for automatic generation on our side (recommended).</p>\n<h4 id=\"platform_linkedinlocations\">platform_linkedin.locations</h4>\n<p>'platform_linkedin.locations': Country is a 2 characters code (ISO 3166-1 alpha-2). Targeting by only zip code ist not possible.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"a315ba07-9156-4945-aa32-e6862c9fe938","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_linkedin\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_url\": \"https://production-banners.s3-eu-west-1.amazonaws.com/squared12345.png\",\n        \"video_url\": \"https://videos.hicandidate.com/test.mp4\",\n        \"daily_budget\": 11,\n        \"ad_text\": \"Starte jetzt deinen neuen Job als Account Manager (M/W/D) bei socialtelligence GmbH in Stuttgart.\",\n        \"ad_title\": \"Account Manager (m/w/d)\",\n        \"promoted_url\": \"https://www.hicandidate.com/\",\n        \"start_date\": \"2026-08-04\",\n        \"end_date\": \"2026-12-10\",\n        \"cta_button_type\": \"APPLY\",\n        \"costs_cap\": 0,\n        \"language\": \"de\",\n        \"skill_list\": \"[]\",\n        \"locations\": [\n            {\n                \"zip\": \"70619\",\n                \"city\": \"Stuttgart\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"ok\"\n}"}],"_postman_id":"acfeb1d9-d2e0-4246-a417-450b57fa8f18"},{"name":"Update Google campaign","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\n"]}}],"id":"d4361c74-8770-4f9b-b285-1a06ddfd5480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_google\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_squared\": \"https://images.hicandidate.com/squared.jpeg\",\n        \"image_horizontal\": \"https://images.hicandidate.com/horiz.jpeg\",\n        \"video_url\": \"https://videos.hicandidate.com/horiz.mp4\",\n        \"daily_budget\": 10,\n        \"max_bid\": 0,\n        \"promoted_url\": \"https://www.socialtelligence.io/\",\n        \"start_date\": \"2026-08-08\",\n        \"end_date\": \"2026-12-15\",\n        \"locations\": [\n            {\n                \"city\": \"Stuttgart\",\n                \"zip\": \"70176\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ],\n        \"ad_headline\": \"\",\n        \"ad_long_headline\": \"\",\n        \"ad_description\": \"\",\n        \"ad_business_name\": \"socialtelligence\",\n        \"ad_cta_text\": \"Jetzt bewerben\",\n        \"keywords\": \"[]\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Updates or creates the platform_google campaign configuration for an existing job.</p>\n<h3 id=\"patch-behavior\">PATCH behavior</h3>\n<p>Send only the <code>platform_google</code> fields you want to change. Existing values not included in the request remain unchanged. If no campaign exists yet, the supplied platform data can be used to create it.</p>\n<h3 id=\"campaign-status\">Campaign status</h3>\n<p>Use <code>ACTIVE</code> to activate/create a campaign and <code>PAUSED</code> to keep or set it paused.</p>\n<h3 id=\"endpoint\">Endpoint</h3>\n<p>This uses the same job update endpoint as <strong>Update job</strong>. The platform object in the JSON body determines which campaign is changed.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<h4 id=\"platform_googlestatus\">platform_google.status</h4>\n<p>'platform_google.status' should be one of the following: 'ACTIVE' or 'PAUSED'</p>\n<h4 id=\"platform_googlead_type\">platform_google.ad_type</h4>\n<p>'platform_google.ad_type' should be one of the following: 'CLICK_AD', 'CONVERSION_AD' or 'PMAX_CONVERSION_AD'</p>\n<h4 id=\"platform_googleimage_squared\">platform_google.image_squared</h4>\n<p>'platform_google.image_squared'. Example: '<a href=\"https://img.hicandidate.com/jobiq/image001.png'\">https://img.hicandidate.com/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000.</p>\n<h4 id=\"platform_googleimage_horizontal\">platform_google.image_horizontal</h4>\n<p>'platform_google.image_horizontal'. Example: '<a href=\"https://img.hicandidate.com/jobiq/image001.png'\">https://img.hicandidate.com/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000.</p>\n<h4 id=\"platform_googlelogo_squared-optional\">platform_google.logo_squared [OPTIONAL]</h4>\n<p>'platform_google.logo_squared'. Example: '<a href=\"https://img.hicandidate.com/jobiq/image001.png'\">https://img.hicandidate.com/logo.png'</a>. Is optional.</p>\n<h4 id=\"platform_googlevideo_url\">platform_google.video_url</h4>\n<p>'platform_google.video_url'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000. The video must be at least 500px in height and width. Suggestion: w:1280 x h:720px.</p>\n<h4 id=\"platform_googledaily_budget\">platform_google.daily_budget</h4>\n<p>'platform_google.daily_budget' have to be numeric for instance 20.00 and &gt;= 10.0 and &lt;= 200.0</p>\n<h4 id=\"platform_googlemax_bid\">platform_google.max_bid</h4>\n<p>'platform_google.max_bid' have to be numeric for instance 2.00. Set to 0 for automatic (recommended)</p>\n<h4 id=\"platform_googlepromoted_url\">platform_google.promoted_url</h4>\n<p>'platform_google.promoted_url' starts with 'http://' or 'https://'. Max. 2000 characters.</p>\n<h4 id=\"platform_googlestart_date\">platform_google.start_date</h4>\n<p>'platform_google.start_date'. Example: '2022-07-12'. Format: YYYY-MM-DD</p>\n<h4 id=\"platform_googleend_date\">platform_google.end_date</h4>\n<p>'platform_google.end_date'. Example: '2022-07-12'. Format: YYYY-MM-DD. This date defines the last day for the ads run time. This date is included to the run time of the ad.</p>\n<h4 id=\"platform_googlelocations\">platform_google.locations</h4>\n<p>'platform_google.locations': Country is a 2 characters code (ISO 3166-1 alpha-2).</p>\n<h4 id=\"platform_googlead_headline\">platform_google.ad_headline</h4>\n<p>'platform_google.ad_headline' length should be &lt;= 30 characters. Leave it empty (\"\") for automatic generation on our side (recommended).</p>\n<h4 id=\"platform_googlead_long_headline\">platform_google.ad_long_headline</h4>\n<p>'platform_google.ad_long_headline' length should be &lt;= 90 characters. Leave it empty (\"\") for automatic generation on our side (recommended).</p>\n<h4 id=\"platform_googlead_description\">platform_google.ad_description</h4>\n<p>'platform_google.ad_title' length should be &lt;=90 characters. Leave it empty (\"\") for automatic generation on our side (recommended).</p>\n<h4 id=\"platform_googlead_business_name\">platform_google.ad_business_name</h4>\n<p>'platform_google.ad_business_name' length should be &gt; 0 and &lt;=25 characters.</p>\n<h4 id=\"platform_googlead_cta_text\">platform_google.ad_cta_text</h4>\n<p>'platform_linkedin.ad_cta_text' should be one of the following: 'None', 'Jetzt bewerben', 'Mehr', 'Apply Now', 'See More'. Defines the text on the click to action button. Set to 'None' if you do not want a button with text.</p>\n<h4 id=\"platform_googlekeywords\">platform_google.keywords</h4>\n<p>'platform_google.keywords': LIST as STRING. Keywords for the targeting. Leave it empty (\"[]\") for automatic generation on our side (recommended).</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"5531f082-81fb-4eba-b763-99e5b62c3a2b","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_google\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_squared\": \"https://images.hicandidate.com/squared.jpeg\",\n        \"image_horizontal\": \"https://images.hicandidate.com/horiz.jpeg\",\n        \"video_url\": \"https://videos.hicandidate.com/horiz.mp4\",\n        \"daily_budget\": 10,\n        \"max_bid\": 0,\n        \"promoted_url\": \"https://www.socialtelligence.io/\",\n        \"start_date\": \"2026-08-08\",\n        \"end_date\": \"2026-12-15\",\n        \"locations\": [\n            {\n                \"city\": \"Stuttgart\",\n                \"zip\": \"70176\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ],\n        \"ad_headline\": \"\",\n        \"ad_long_headline\": \"\",\n        \"ad_description\": \"\",\n        \"ad_business_name\": \"socialtelligence\",\n        \"ad_cta_text\": \"Jetzt bewerben\",\n        \"keywords\": \"[]\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"ok\"\n}"}],"_postman_id":"d4361c74-8770-4f9b-b285-1a06ddfd5480"},{"name":"Update TikTok campaign","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\n"]}}],"id":"c5f04159-34e2-407b-8229-9bdb5486414e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_tiktok\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_url\": \"https://images.hicandidate.com/vertical.jpeg\",\n        \"video_url\": \"https://img.hicandidate.com/tt_vid.mp4\",\n        \"promoted_url\": \"https://www.hicandidate.com/demo\",\n        \"daily_budget\": 20,\n        \"start_date\": \"2026-08-20\",\n        \"end_date\": \"2026-08-25\",\n        \"job_title\": \"Account Manager (m/w/d)\",\n        \"ad_text\": \"Account Manager (m/w/d)\",\n        \"locations\": [\n            {\n                \"zip\": \"70619\",\n                \"city\": \"Stuttgart\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456","description":"<p>Updates or creates the platform_tiktok campaign configuration for an existing job.</p>\n<h3 id=\"patch-behavior\">PATCH behavior</h3>\n<p>Send only the <code>platform_tiktok</code> fields you want to change. Existing values not included in the request remain unchanged. If no campaign exists yet, the supplied platform data can be used to create it.</p>\n<h3 id=\"campaign-status\">Campaign status</h3>\n<p>Use <code>ACTIVE</code> to activate/create a campaign and <code>PAUSED</code> to keep or set it paused.</p>\n<h3 id=\"endpoint\">Endpoint</h3>\n<p>This uses the same job update endpoint as <strong>Update job</strong>. The platform object in the JSON body determines which campaign is changed.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<h4 id=\"platform_tiktokstatus\">platform_tiktok.status</h4>\n<p>'platform_tiktok.status' should be one of the following: 'ACTIVE' or 'PAUSED'</p>\n<h4 id=\"platform_tiktokad_type\">platform_tiktok.ad_type</h4>\n<p>'platform_tiktok.ad_type' should be one of the following: 'CLICK_AD' or 'CONVERSION_AD'</p>\n<h4 id=\"platform_tiktokimage_url\">platform_tiktok.image_url</h4>\n<p>'platform_tiktok.image_url'. Example: '<a href=\"https://img.hicandidate.com/jobiq/image001.png'\">https://img.hicandidate.com/jobiq/image001.png'</a>. Must end with on of the following: .png, .jpeg, .jpg, .PNG, .JPEG, .JPG and starts with http:// or https://. Max length 2000</p>\n<h4 id=\"platform_tiktokvideo_url\">platform_tiktok.video_url</h4>\n<p>'platform_tiktok.video_url'. Example: '<a href=\"https://www.hicandidate/video001.mp4'\">https://www.hicandidate/video001.mp4'</a>. Must end with on of the following: .mp4, .MP4 and starts with http:// or https://. Max length 2000 characters of url length. 1080 × 1920px and 9:16 and max. 60 seconds.</p>\n<h4 id=\"platform_tiktokpromoted_url\">platform_tiktok.promoted_url</h4>\n<p>'platform_linkedin.promoted_url' starts with 'http://' or 'https://'. Max. 2000 characters.</p>\n<h4 id=\"platform_tiktokdaily_budget\">platform_tiktok.daily_budget</h4>\n<p>'platform_tiktok.daily_budget' have to be numeric for instance 20.00 and &gt;= 20.0 and &lt;= 200.0</p>\n<h4 id=\"platform_tiktokstart_date\">platform_tiktok.start_date</h4>\n<p>'platform_tiktok.start_date'. Example: '2022-07-12'. Format: YYYY-MM-DD</p>\n<h4 id=\"platform_tiktokend_date\">platform_tiktok.end_date</h4>\n<p>'platform_tiktok.end_date'. Example: '2022-07-19'. Format: YYYY-MM-DD. This date defines the last day for the ads run time. This date is included to the run time of the ad.</p>\n<h4 id=\"platform_tiktokjob_title\">platform_tiktok.job_title</h4>\n<p>'platform_tiktok.job_title' length should be &gt; 0 and &lt;=500 characters.</p>\n<h4 id=\"platform_tiktokad_text\">platform_tiktok.ad_text</h4>\n<p>'platform_tiktok.ad_text' length should be &gt; 0 and &lt;=100 characters.</p>\n<h4 id=\"platform_tiktoklocations\">platform_tiktok.locations</h4>\n<p>'platform_tiktok.locations': Valid example: [ {'city': 'Stuttgart', 'zip': '70619', 'state': 'Baden-Württemberg', 'country': 'DE'} ]. Country is a 2 characters code (ISO 3166-1 alpha-2).</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","orders","1","jobs","123456"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"81f10fe4-46df-4a08-91b7-a053b1cf9c81","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"platform_tiktok\": {\n        \"status\": \"PAUSED\",\n        \"ad_type\": \"CLICK_AD\",\n        \"image_url\": \"https://images.hicandidate.com/vertical.jpeg\",\n        \"video_url\": \"https://img.hicandidate.com/tt_vid.mp4\",\n        \"promoted_url\": \"https://www.hicandidate.com/demo\",\n        \"daily_budget\": 20,\n        \"start_date\": \"2026-08-20\",\n        \"end_date\": \"2026-08-25\",\n        \"job_title\": \"Account Manager (m/w/d)\",\n        \"ad_text\": \"Account Manager (m/w/d)\",\n        \"locations\": [\n            {\n                \"zip\": \"70619\",\n                \"city\": \"Stuttgart\",\n                \"state\": \"Baden-Württemberg\",\n                \"country\": \"DE\"\n            }\n        ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/orders/1/jobs/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"ok\"\n}"}],"_postman_id":"c5f04159-34e2-407b-8229-9bdb5486414e"}],"id":"6c601515-32b5-4c33-8da7-383078ce95aa","description":"<p>Create or update channel-specific campaign settings for an existing job. All requests use the job PATCH endpoint.</p>\n","_postman_id":"6c601515-32b5-4c33-8da7-383078ce95aa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}},{"name":"Media automation","item":[{"name":"Create image","event":[{"listen":"prerequest","script":{"exec":["",""],"type":"text/javascript","id":"fef3b327-ff54-48fe-974f-545f2c07e7cb"}}],"id":"b7d222a1-3e45-46d1-a55e-45109a26ed1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"format\": \"HORIZONTAL\",\n    \"contract:payload\": \"Vollzeit\",\n    \"location:payload\": \"Stuttgart\",\n    \"employer:payload\": \"st GmbH\",\n    \"jobtitle:payload\": \"Börsenguru (m/w/d)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/media/automation/image","description":"<p>Creates an image with the image automation configuration of the authenticated client.</p>\n<h3 id=\"required-field\">Required field</h3>\n<p><code>format</code> must be one of <code>HORIZONTAL</code>, <code>VERTICAL</code> or <code>SQUARED</code>.</p>\n<p>Additional required fields are client-specific. Call <strong>Get image parameters</strong> to retrieve them before sending this request.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","media","automation","image"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"bfc3ffd8-374a-481a-bcac-c28d72963c6e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"format\": \"HORIZONTAL\",\n    \"contract:payload\": \"Vollzeit\",\n    \"location:payload\": \"Stuttgart\",\n    \"employer:payload\": \"st GmbH\",\n    \"jobtitle:payload\": \"Börsenguru (m/w/d)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/media/automation/image","description":"Creates an image with the image automation configuration of the authenticated client.\n\n### Required field\n`format` must be one of `HORIZONTAL`, `VERTICAL` or `SQUARED`.\n\nAdditional required fields are client-specific. Call **Get image parameters** to retrieve them before sending this request."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"https://example.com/generated-image.jpeg\"\n}"}],"_postman_id":"b7d222a1-3e45-46d1-a55e-45109a26ed1f"},{"name":"Create video","event":[{"listen":"prerequest","script":{"exec":["",""],"type":"text/javascript","id":"0169ce0b-f3f8-4112-a9c3-69c75135d102"}}],"id":"fdf20f51-361b-446b-accc-3f44eb4d75aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"template_id\": \"2a5ad83e-77d1-4f27-9685-7ec2fd8a82eb\",\n    \"4a4ec68e-4558-4237-816d-7552563985b2\": \"Kundenberater (m/w/d)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/media/automation/video","description":"<p>Creates a video using one of the templates configured for the authenticated client.</p>\n<h3 id=\"required\">Required</h3>\n<ul>\n<li><code>template_id</code> must identify one of the templates returned by <strong>Get video templates</strong>.</li>\n<li>All template-specific parameters returned for that template must be included in the request body.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}},"urlObject":{"path":["v1","media","automation","video"],"host":["https://api.hicandidate.com"],"query":[],"variable":[]}},"response":[{"id":"08620387-c210-4c19-baf0-ee02ba3fb608","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"template_id\": \"2a5ad83e-77d1-4f27-9685-7ec2fd8a82eb\",\n    \"4a4ec68e-4558-4237-816d-7552563985b2\": \"Kundenberater (m/w/d)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hicandidate.com/v1/media/automation/video","description":"Creates a video using one of the templates configured for the authenticated client.\n\n### Required\n- `template_id` must identify one of the templates returned by **Get video templates**.\n- All template-specific parameters returned for that template must be included in the request body."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": \"https://example.com/generated-video.mp4\"\n}"}],"_postman_id":"fdf20f51-361b-446b-accc-3f44eb4d75aa"}],"id":"e4d85c93-44b0-4c4c-89bc-d5a1acf238e2","description":"<p>Generate client-specific image and video assets. Available parameters/templates depend on the client configuration.</p>\n","_postman_id":"e4d85c93-44b0-4c4c-89bc-d5a1acf238e2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}},{"name":"Conversion Tracking","item":[{"name":"Application started","id":"83040130-afe0-4e63-97ef-7c99c73bdc01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.hicandidate.com/v1/conversion?hic_jid=0","description":"<p>Records the <strong>application started</strong> conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.</p>\n<h3 id=\"required\">Required</h3>\n<p><code>hic_jid</code> is required and must be an integer.</p>\n<h3 id=\"testing\">Testing</h3>\n<p>Set <code>hic_jid=0</code> to validate the request without forwarding events to the advertising platform services.</p>\n<h3 id=\"platform-parameters\">Platform parameters</h3>\n<p>Enable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.</p>\n<p>This endpoint does not use the API Bearer token in the current implementation.</p>\n","urlObject":{"path":["v1","conversion"],"host":["https://api.hicandidate.com"],"query":[{"description":{"content":"<p>HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services.</p>\n","type":"text/plain"},"key":"hic_jid","value":"0"},{"disabled":true,"description":{"content":"<p>Platform marker required together with fbclid for Meta conversion forwarding.</p>\n","type":"text/plain"},"key":"hic_platform","value":"meta"},{"disabled":true,"description":{"content":"<p>Meta click ID.</p>\n","type":"text/plain"},"key":"fbclid","value":"test-fbclid"},{"disabled":true,"description":{"content":"<p>Google click ID.</p>\n","type":"text/plain"},"key":"gclid","value":"test-gclid"},{"disabled":true,"description":{"content":"<p>LinkedIn click ID.</p>\n","type":"text/plain"},"key":"li_fat_id","value":"test-li-fat-id"},{"disabled":true,"description":{"content":"<p>Twitter/X conversion event ID.</p>\n","type":"text/plain"},"key":"hic_twitter_conversion_event_id","value":"event-id"},{"disabled":true,"description":{"content":"<p>Twitter/X pixel ID.</p>\n","type":"text/plain"},"key":"hic_twitter_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>Twitter/X click ID.</p>\n","type":"text/plain"},"key":"twclid","value":"test-twclid"},{"disabled":true,"description":{"content":"<p>TikTok pixel ID.</p>\n","type":"text/plain"},"key":"hic_tiktok_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>TikTok click ID.</p>\n","type":"text/plain"},"key":"ttclid","value":"test-ttclid"},{"disabled":true,"description":{"content":"<p>ChatGPT/OpenAI Ads referral parameter.</p>\n","type":"text/plain"},"key":"oppref","value":"test-oppref"}],"variable":[]}},"response":[{"id":"0f4bae8e-cfec-4438-9162-09e7066a69a2","name":"Success","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[],"url":{"raw":"https://api.hicandidate.com/v1/conversion?hic_jid=0","host":["https://api.hicandidate.com"],"path":["v1","conversion"],"query":[{"key":"hic_jid","value":"0","description":"HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services."},{"key":"hic_platform","value":"meta","description":"Platform marker required together with fbclid for Meta conversion forwarding.","disabled":true},{"key":"fbclid","value":"test-fbclid","description":"Meta click ID.","disabled":true},{"key":"gclid","value":"test-gclid","description":"Google click ID.","disabled":true},{"key":"li_fat_id","value":"test-li-fat-id","description":"LinkedIn click ID.","disabled":true},{"key":"hic_twitter_conversion_event_id","value":"event-id","description":"Twitter/X conversion event ID.","disabled":true},{"key":"hic_twitter_pixel_id","value":"pixel-id","description":"Twitter/X pixel ID.","disabled":true},{"key":"twclid","value":"test-twclid","description":"Twitter/X click ID.","disabled":true},{"key":"hic_tiktok_pixel_id","value":"pixel-id","description":"TikTok pixel ID.","disabled":true},{"key":"ttclid","value":"test-ttclid","description":"TikTok click ID.","disabled":true},{"key":"oppref","value":"test-oppref","description":"ChatGPT/OpenAI Ads referral parameter.","disabled":true}]},"description":"Records the **application started** conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.\n\n### Required\n`hic_jid` is required and must be an integer.\n\n### Testing\nSet `hic_jid=0` to validate the request without forwarding events to the advertising platform services.\n\n### Platform parameters\nEnable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.\n\nThis endpoint does not use the API Bearer token in the current implementation."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": []\n}"}],"_postman_id":"83040130-afe0-4e63-97ef-7c99c73bdc01"},{"name":"Application completed","id":"81bb4edf-1034-4016-a625-83c0fcf10b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.hicandidate.com/v1/conversion2?hic_jid=0","description":"<p>Records the <strong>application completed</strong> conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.</p>\n<h3 id=\"required\">Required</h3>\n<p><code>hic_jid</code> is required and must be an integer.</p>\n<h3 id=\"testing\">Testing</h3>\n<p>Set <code>hic_jid=0</code> to validate the request without forwarding events to the advertising platform services.</p>\n<h3 id=\"platform-parameters\">Platform parameters</h3>\n<p>Enable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.</p>\n<p>This endpoint does not use the API Bearer token in the current implementation.</p>\n","urlObject":{"path":["v1","conversion2"],"host":["https://api.hicandidate.com"],"query":[{"description":{"content":"<p>HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services.</p>\n","type":"text/plain"},"key":"hic_jid","value":"0"},{"disabled":true,"description":{"content":"<p>Platform marker required together with fbclid for Meta conversion forwarding.</p>\n","type":"text/plain"},"key":"hic_platform","value":"meta"},{"disabled":true,"description":{"content":"<p>Meta click ID.</p>\n","type":"text/plain"},"key":"fbclid","value":"test-fbclid"},{"disabled":true,"description":{"content":"<p>Google click ID.</p>\n","type":"text/plain"},"key":"gclid","value":"test-gclid"},{"disabled":true,"description":{"content":"<p>LinkedIn click ID.</p>\n","type":"text/plain"},"key":"li_fat_id","value":"test-li-fat-id"},{"disabled":true,"description":{"content":"<p>Twitter/X conversion event ID.</p>\n","type":"text/plain"},"key":"hic_twitter_conversion_event_id","value":"event-id"},{"disabled":true,"description":{"content":"<p>Twitter/X pixel ID.</p>\n","type":"text/plain"},"key":"hic_twitter_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>Twitter/X click ID.</p>\n","type":"text/plain"},"key":"twclid","value":"test-twclid"},{"disabled":true,"description":{"content":"<p>TikTok pixel ID.</p>\n","type":"text/plain"},"key":"hic_tiktok_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>TikTok click ID.</p>\n","type":"text/plain"},"key":"ttclid","value":"test-ttclid"},{"disabled":true,"description":{"content":"<p>ChatGPT/OpenAI Ads referral parameter.</p>\n","type":"text/plain"},"key":"oppref","value":"test-oppref"}],"variable":[]}},"response":[{"id":"1726598a-d719-4e63-86bf-3526c7202af4","name":"Success","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[],"url":{"raw":"https://api.hicandidate.com/v1/conversion2?hic_jid=0","host":["https://api.hicandidate.com"],"path":["v1","conversion2"],"query":[{"key":"hic_jid","value":"0","description":"HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services."},{"key":"hic_platform","value":"meta","description":"Platform marker required together with fbclid for Meta conversion forwarding.","disabled":true},{"key":"fbclid","value":"test-fbclid","description":"Meta click ID.","disabled":true},{"key":"gclid","value":"test-gclid","description":"Google click ID.","disabled":true},{"key":"li_fat_id","value":"test-li-fat-id","description":"LinkedIn click ID.","disabled":true},{"key":"hic_twitter_conversion_event_id","value":"event-id","description":"Twitter/X conversion event ID.","disabled":true},{"key":"hic_twitter_pixel_id","value":"pixel-id","description":"Twitter/X pixel ID.","disabled":true},{"key":"twclid","value":"test-twclid","description":"Twitter/X click ID.","disabled":true},{"key":"hic_tiktok_pixel_id","value":"pixel-id","description":"TikTok pixel ID.","disabled":true},{"key":"ttclid","value":"test-ttclid","description":"TikTok click ID.","disabled":true},{"key":"oppref","value":"test-oppref","description":"ChatGPT/OpenAI Ads referral parameter.","disabled":true}]},"description":"Records the **application completed** conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.\n\n### Required\n`hic_jid` is required and must be an integer.\n\n### Testing\nSet `hic_jid=0` to validate the request without forwarding events to the advertising platform services.\n\n### Platform parameters\nEnable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.\n\nThis endpoint does not use the API Bearer token in the current implementation."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": []\n}"}],"_postman_id":"81bb4edf-1034-4016-a625-83c0fcf10b4a"},{"name":"Quality application","id":"4f853664-4dc7-4aee-8096-2482fe6860d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.hicandidate.com/v1/conversion3?hic_jid=0","description":"<p>Records the <strong>quality application</strong> conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.</p>\n<h3 id=\"required\">Required</h3>\n<p><code>hic_jid</code> is required and must be an integer.</p>\n<h3 id=\"testing\">Testing</h3>\n<p>Set <code>hic_jid=0</code> to validate the request without forwarding events to the advertising platform services.</p>\n<h3 id=\"platform-parameters\">Platform parameters</h3>\n<p>Enable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.</p>\n<p>This endpoint does not use the API Bearer token in the current implementation.</p>\n","urlObject":{"path":["v1","conversion3"],"host":["https://api.hicandidate.com"],"query":[{"description":{"content":"<p>HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services.</p>\n","type":"text/plain"},"key":"hic_jid","value":"0"},{"disabled":true,"description":{"content":"<p>Platform marker required together with fbclid for Meta conversion forwarding.</p>\n","type":"text/plain"},"key":"hic_platform","value":"meta"},{"disabled":true,"description":{"content":"<p>Meta click ID.</p>\n","type":"text/plain"},"key":"fbclid","value":"test-fbclid"},{"disabled":true,"description":{"content":"<p>Google click ID.</p>\n","type":"text/plain"},"key":"gclid","value":"test-gclid"},{"disabled":true,"description":{"content":"<p>LinkedIn click ID.</p>\n","type":"text/plain"},"key":"li_fat_id","value":"test-li-fat-id"},{"disabled":true,"description":{"content":"<p>Twitter/X conversion event ID.</p>\n","type":"text/plain"},"key":"hic_twitter_conversion_event_id","value":"event-id"},{"disabled":true,"description":{"content":"<p>Twitter/X pixel ID.</p>\n","type":"text/plain"},"key":"hic_twitter_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>Twitter/X click ID.</p>\n","type":"text/plain"},"key":"twclid","value":"test-twclid"},{"disabled":true,"description":{"content":"<p>TikTok pixel ID.</p>\n","type":"text/plain"},"key":"hic_tiktok_pixel_id","value":"pixel-id"},{"disabled":true,"description":{"content":"<p>TikTok click ID.</p>\n","type":"text/plain"},"key":"ttclid","value":"test-ttclid"},{"disabled":true,"description":{"content":"<p>ChatGPT/OpenAI Ads referral parameter.</p>\n","type":"text/plain"},"key":"oppref","value":"test-oppref"}],"variable":[]}},"response":[{"id":"f045c7a1-9c3c-4618-82d5-388a6923eb18","name":"Success","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[],"url":{"raw":"https://api.hicandidate.com/v1/conversion3?hic_jid=0","host":["https://api.hicandidate.com"],"path":["v1","conversion3"],"query":[{"key":"hic_jid","value":"0","description":"HiCandidate job ID. Use 0 for testing; the backend does not forward test events to platform services."},{"key":"hic_platform","value":"meta","description":"Platform marker required together with fbclid for Meta conversion forwarding.","disabled":true},{"key":"fbclid","value":"test-fbclid","description":"Meta click ID.","disabled":true},{"key":"gclid","value":"test-gclid","description":"Google click ID.","disabled":true},{"key":"li_fat_id","value":"test-li-fat-id","description":"LinkedIn click ID.","disabled":true},{"key":"hic_twitter_conversion_event_id","value":"event-id","description":"Twitter/X conversion event ID.","disabled":true},{"key":"hic_twitter_pixel_id","value":"pixel-id","description":"Twitter/X pixel ID.","disabled":true},{"key":"twclid","value":"test-twclid","description":"Twitter/X click ID.","disabled":true},{"key":"hic_tiktok_pixel_id","value":"pixel-id","description":"TikTok pixel ID.","disabled":true},{"key":"ttclid","value":"test-ttclid","description":"TikTok click ID.","disabled":true},{"key":"oppref","value":"test-oppref","description":"ChatGPT/OpenAI Ads referral parameter.","disabled":true}]},"description":"Records the **quality application** conversion event for a HiCandidate job and forwards supported attribution identifiers to the corresponding advertising platform service.\n\n### Required\n`hic_jid` is required and must be an integer.\n\n### Testing\nSet `hic_jid=0` to validate the request without forwarding events to the advertising platform services.\n\n### Platform parameters\nEnable the parameters available from the landing page URL. The backend forwards a platform conversion only when all parameters required for that platform are present.\n\nThis endpoint does not use the API Bearer token in the current implementation."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": []\n}"}],"_postman_id":"4f853664-4dc7-4aee-8096-2482fe6860d7"}],"id":"06a93f90-699d-459e-aeb8-164c60a2223c","description":"<p>The HiCandidate Conversion API allows you to send conversion events back to HiCandidate during the applicant journey.</p>\n<p>The integration is designed to be simple: <strong>you do not need to know which tracking parameters are required by Meta, Google, LinkedIn, TikTok or other advertising platforms.</strong></p>\n<p>HiCandidate and the respective advertising platform automatically add the required tracking parameters to the landing page URL.</p>\n<p>Your application only needs to:</p>\n<ol>\n<li><p>Read the URL parameters when the applicant arrives on your landing page.</p>\n</li>\n<li><p>Store these parameters for the duration of the applicant journey.</p>\n</li>\n<li><p>Send the stored parameters to the appropriate HiCandidate conversion endpoint when a conversion occurs.</p>\n</li>\n</ol>\n<hr />\n<h2 id=\"how-does-it-work\">How does it work?</h2>\n<p>When HiCandidate creates an advertisement, the configured <code>promoted_url</code> is extended with tracking parameters required to identify the job, campaign and advertising platform.</p>\n<p>The advertising platform may add additional parameters when a user clicks the advertisement.</p>\n<p>For example, Meta may add a <code>fbclid</code>, Google may add a <code>gclid</code>, and other platforms may add their own tracking parameters.</p>\n<p>An applicant may therefore arrive on your landing page with a URL similar to:</p>\n<p><a href=\"https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;\">https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;</a>...</p>\n<p>Everything after the <code>?</code> represents the query parameters associated with this visit.</p>\n<p><strong>Your application should capture these parameters when the landing page is opened and store them for later use.</strong></p>\n<p>For example, they can be stored in:</p>\n<ul>\n<li><p>the applicant's session</p>\n</li>\n<li><p>a cookie</p>\n</li>\n<li><p>your application database</p>\n</li>\n<li><p>another temporary server-side storage</p>\n</li>\n</ul>\n<p>The important part is that the parameters remain available until the relevant conversion event occurs.</p>\n<hr />\n<h2 id=\"sending-a-conversion\">Sending a conversion</h2>\n<p>When a conversion occurs, send the stored parameters unchanged to the corresponding HiCandidate conversion endpoint.</p>\n<p>You do not need to filter the parameters.</p>\n<p><strong>Unknown or additional parameters are ignored by HiCandidate.</strong></p>\n<p>This means the easiest and recommended implementation is to preserve the complete query string received on the landing page and forward it to the conversion endpoint.</p>\n<p>For example, if the applicant enters your landing page with:</p>\n<p><a href=\"https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;utm_source=facebook\">https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;utm_source=facebook</a></p>\n<p>you can later send:</p>\n<p>POST <a href=\"https://api.hicandidate.com/v1/conversion?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;utm_source=facebook\">https://api.hicandidate.com/v1/conversion?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;utm_source=facebook</a></p>\n<p>The additional <code>utm_source</code> parameter does not cause an error. HiCandidate simply ignores parameters that are not required for conversion tracking.</p>\n<hr />\n<h1 id=\"conversion-events\">Conversion Events</h1>\n<p>HiCandidate provides three conversion endpoints representing different stages of the applicant journey.</p>\n<h2 id=\"1-conversion--application-started\">1. <code>/conversion</code> — Application started</h2>\n<p>Send this conversion when the applicant starts the application process.</p>\n<p>A typical trigger is a click on a button such as:</p>\n<p><strong>\"Apply now\" / \"Jetzt bewerben\"</strong></p>\n<p>Example:</p>\n<p>POST /v1/conversion?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;...</p>\n<hr />\n<h2 id=\"2-conversion2--application-completed\">2. <code>/conversion2</code> — Application completed</h2>\n<p>Send this conversion after the applicant has successfully completed and submitted the application.</p>\n<p>Use the <strong>same tracking parameters that were captured when the applicant originally arrived on the landing page.</strong></p>\n<p>Example:</p>\n<p>POST /v1/conversion2?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;...</p>\n<hr />\n<h2 id=\"3-conversion3--qualified-application\">3. <code>/conversion3</code> — Qualified application</h2>\n<p>Send this conversion when the application has been reviewed and is considered a good or qualified application.</p>\n<p>This event can occur significantly later than the original ad click or application.</p>\n<p>For this reason, make sure that the original tracking parameters are still associated with the applicant.</p>\n<p>Example:</p>\n<p>POST /v1/conversion3?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123&amp;...</p>\n<hr />\n<h1 id=\"example-applicant-journey\">Example Applicant Journey</h1>\n<p>A typical implementation looks like this:</p>\n<p><strong>1. Applicant clicks an advertisement</strong></p>\n<p>Meta, Google, LinkedIn, TikTok or another advertising platform opens the <code>promoted_url</code>.</p>\n<p>↓</p>\n<p><strong>2. Applicant arrives on your landing page</strong></p>\n<p>Example:</p>\n<p><a href=\"https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123\">https://your-domain.com/career?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123</a></p>\n<p>↓</p>\n<p><strong>3. Store the parameters</strong></p>\n<p>Your application stores:</p>\n<p>hic_jid=123<br />hic_platform=meta<br />fbclid=ABC123</p>\n<p>For example in the applicant's session.</p>\n<p>↓</p>\n<p><strong>4. Applicant clicks \"Apply now\"</strong></p>\n<p>Send:</p>\n<p>POST /v1/conversion?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123</p>\n<p>↓</p>\n<p><strong>5. Applicant completes the application</strong></p>\n<p>Send:</p>\n<p>POST /v1/conversion2?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123</p>\n<p>↓</p>\n<p><strong>6. Application is reviewed and considered qualified</strong></p>\n<p>Send:</p>\n<p>POST /v1/conversion3?hic_jid=123&amp;hic_platform=meta&amp;fbclid=ABC123</p>\n<hr />\n<h1 id=\"important\">Important</h1>\n<p>The tracking parameters should always originate from the URL used when the applicant arrived on your landing page.</p>\n<p>Do not generate advertising tracking parameters such as <code>fbclid</code>, <code>gclid</code> or similar identifiers yourself.</p>\n<p>Simply <strong>capture → store → forward</strong> the parameters received with the landing page request.</p>\n<p>The same stored parameters can be reused for <code>/conversion</code>, <code>/conversion2</code> and <code>/conversion3</code>.</p>\n<p>Unknown parameters are ignored by HiCandidate and therefore do not need to be removed before sending the request.</p>\n","_postman_id":"06a93f90-699d-459e-aeb8-164c60a2223c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"55d54b8c-5d85-4c83-9311-8192b98258c6","id":"55d54b8c-5d85-4c83-9311-8192b98258c6","name":"HiCandidate™ API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"variable":[{"key":"BASE_URL","value":"https://api.hicandidate.com"},{"key":"API_TOKEN","value":""},{"key":"ORDER_ID","value":"1"},{"key":"JOB_ID","value":"123456"}]}