{"info":{"_postman_id":"4dd584d9-86f7-47f4-976f-661fc8bbd28a","name":"WebinarKit API","description":"<html><head></head><body><p>WebinarKit's public API. This API allows you to do things like register people for webinars, retrieve information about webinars, create, retrieve update, and delete accounts (for White Label customers) and more.</p>\n<p>For some endpoints, you'll need to include your API key in order to successfully complete your request.</p>\n<p>You can generate/find your API key in the settings page of your WebinarKit account.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22597176","collectionId":"4dd584d9-86f7-47f4-976f-661fc8bbd28a","publishedId":"Uzs435mo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-03T18:53:34.000Z"},"item":[{"name":"Accounts","item":[{"name":"/api/account/create","id":"11d23cb0-9c46-40f8-a896-514fc278081a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": false,\n  \"meetings_enabled\": false,\n  \"site_builder_enabled\": false,\n  \"ai_suite_enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/create","description":"<p>Create an account (belonging to the main/owner account). This endpoint is for White Label customers.</p>\n<p>The \"accountType\" field can be set to \"admin\", \"editor\", \"analyst\", or \"mod\".</p>\n<ul>\n<li>If you pass \"admin\", the subaccount will have the ability to create, edit, and view all aspects of events.</li>\n<li>If you pass \"editor\", the subaccount will only be able to edit and view events.</li>\n<li>If you pass \"analyst\", the subaccount will only be able to view event analytics.</li>\n<li>If you pass \"mod\", the subaccount will only be able to access the event control room.</li>\n</ul>\n<p>The \"subaccount_features\" field can be set to \"both\", \"automated\", or \"live\".</p>\n<ul>\n<li>If you pass \"both\", the subaccount will be able to create both automated and live webinars.</li>\n<li>If you pass \"automated\", the subaccount will only be able to create automated webinars.</li>\n<li>If you pass \"live\", the subaccount will only be able to create live webinars.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","account","create"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"7e1d1369-6f72-44d8-8547-8ede0b62e5ae","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": false,\n  \"meetings_enabled\": false,\n  \"site_builder_enabled\": false,\n  \"ai_suite_enabled\": false\n}\n","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"message\": \"Account successfully created.\"\n}"},{"id":"8b3d3ed5-328e-47c8-9259-c30fac0dc324","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": false,\n  \"meetings_enabled\": false,\n  \"site_builder_enabled\": false,\n  \"ai_suite_enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://webinarkit.com/api/account/create?Authorization=Bearer [api_key]","protocol":"https","host":["webinarkit","com"],"path":["api","account","create"],"query":[{"key":"Authorization","value":"Bearer [api_key]"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error: Account with that email address already exists.\"\n}"}],"_postman_id":"11d23cb0-9c46-40f8-a896-514fc278081a"},{"name":"/api/account","id":"fad78d26-4939-4b77-b77e-07479128b07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://webinarkit.com/api/account?email=test-sub-pr1655@test.com","description":"<p>Retrieve an account (belonging to the main/owner account). This endpoint is for White Label customers.</p>\n","urlObject":{"protocol":"https","path":["api","account"],"host":["webinarkit","com"],"query":[{"key":"email","value":"test-sub-pr1655@test.com"}],"variable":[]}},"response":[{"id":"032db744-b3ec-4b9b-8792-4c72c989ed01","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://webinarkit.com/api/account?email=example@email.com","protocol":"https","host":["webinarkit","com"],"path":["api","account"],"query":[{"key":"email","value":"example@email.com"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"account\": {\n        \"email\": \"example@email.com\",\n        \"name\": \"Example Name\",\n        \"accountType\": \"admin\",\n        \"webinars\": [],\n        \"meetings\": []\n    }\n}"},{"id":"49948cf0-5e44-4613-bea7-80e8e08eb450","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"url":{"raw":"https://webinarkit.com/api/account?email=example@email.com","protocol":"https","host":["webinarkit","com"],"path":["api","account"],"query":[{"key":"email","value":"example@email.com"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error: No user with email exists.\"\n}"}],"_postman_id":"fad78d26-4939-4b77-b77e-07479128b07f"},{"name":"/api/account/update","id":"3c9eb34f-0343-4ead-96a8-83cd0a44e340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"new_email\": \"new@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": true,\n  \"meetings_enabled\": true,\n  \"site_builder_enabled\": true,\n  \"ai_suite_enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/update","description":"<p>Update an account (belonging to the main/owner account). This endpoint is for White Label customers.</p>\n<p>If updating the email address of a subaccount, pass the new email address via the \"new_email\" key.</p>\n","urlObject":{"protocol":"https","path":["api","account","update"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"c4cca061-bcc1-492a-9d32-c6cba0e98dde","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"new_email\": \"new@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": true,\n  \"meetings_enabled\": true,\n  \"site_builder_enabled\": true,\n  \"ai_suite_enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"message\": \"Account successfully updated.\"\n}"},{"id":"49e35ed3-1a97-4666-b7f0-4b9520c5dfd4","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"example@email.com\",\n  \"new_email\": \"new@email.com\",\n  \"password\": \"newpassword123\",\n  \"name\": \"Example Name\",\n  \"accountType\": \"admin\",\n  \"automated_webinars_enabled\": true,\n  \"live_webinars_enabled\": true,\n  \"meetings_enabled\": true,\n  \"site_builder_enabled\": true,\n  \"ai_suite_enabled\": false\n}\n","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/update"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error updating account. Please try again or contact support.\"\n}"}],"_postman_id":"3c9eb34f-0343-4ead-96a8-83cd0a44e340"},{"name":"/api/account/delete","id":"61c76f96-9703-42b8-82ab-86a86cccb00d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/delete","description":"<p>Delete an account (belonging to the main/owner account). This endpoint is for White Label customers.</p>\n","urlObject":{"protocol":"https","path":["api","account","delete"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"9b043e79-0794-4026-9624-c6d440f527fb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/delete"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"message\": \"Account successfully deleted.\"\n}"},{"id":"a48d4866-96a5-470d-9cc2-c381e6443aaf","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/delete"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error deleting account. Please try again or contact support.\"\n}"}],"_postman_id":"61c76f96-9703-42b8-82ab-86a86cccb00d"},{"name":"/api/account/webinar/assign","id":"b25e0681-1865-440f-a40b-742879dcef71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/assign","description":"<p>Assigns (shares) a webinar from the main account to a subaccount.<br />Both accounts will reference the same webinar document — identical<br />to what the in-app UI does. This endpoint is idempotent (safe to<br />call multiple times).</p>\n<p>Requires a white_label_enabled main account.</p>\n<h2 id=\"body-field-descriptions\"><strong>Body</strong> field descriptions</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>subaccount_email</code></td>\n<td>Email of the subaccount (must be owned by the main account)</td>\n</tr>\n<tr>\n<td><code>webinar_id</code></td>\n<td>ID of the webinar on the main account</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"error-codes\"><strong>Error codes</strong></h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>When</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>400</code></td>\n<td>Missing <code>webinar_id</code>, <code>subaccount_email</code>, or Bearer token</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>Invalid API key / account not <code>white_label_enabled</code> / webinar doesn't belong to main account / subaccount not owned by main account</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>No account found with that <code>subaccount_email</code> (assign &amp; clone also return 404 if webinar not found)</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>Server/DB error</td>\n</tr>\n</tbody>\n</table>\n</div><p><em>This endpoint is idempotent — if the webinar is already assigned, it will return</em> <code>_200_</code> <em>with</em> <code>_\"Webinar already assigned to subaccount._</code></p>\n","urlObject":{"protocol":"https","path":["api","account","webinar","assign"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"2028a7fb-1869-4efd-9990-a26d06399fbd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/assign"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"message\": \"Webinar successfully assigned to subaccount.\"\r\n}"},{"id":"eb45005e-a3bb-4f19-89f5-94411d2f1871","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/assign"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"message\": \"Error: Not authorized to perform this action.\"\r\n}"}],"_postman_id":"b25e0681-1865-440f-a40b-742879dcef71"},{"name":"/api/account/webinar/remove","id":"96a429ef-717b-42fa-81fc-5807c7550979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/remove","description":"<p>Removes a webinar from a subaccount's webinar list.</p>\n<p>Requires a white_label_enabled main account.</p>\n<h2 id=\"body-field-descriptions\"><strong>Body</strong> field descriptions</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>subaccount_email</code></td>\n<td>Email of the subaccount (must be owned by the main account)</td>\n</tr>\n<tr>\n<td><code>webinar_id</code></td>\n<td>ID of the webinar on the main account</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"error-codes\"><strong>Error codes</strong></h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>When</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>400</code></td>\n<td>Missing <code>webinar_id</code>, <code>subaccount_email</code>, or Bearer token</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>Invalid API key / account not <code>white_label_enabled</code> / webinar doesn't belong to main account / subaccount not owned by main account</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>No account found with that <code>subaccount_email</code> (assign &amp; clone also return 404 if webinar not found)</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>Server/DB error</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","account","webinar","remove"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"32d496fa-4dc8-433e-adc7-4331d9d418dd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/remove"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"message\": \"Webinar successfully removed from subaccount.\"\r\n}\r\n"},{"id":"a06125c0-7d6b-4f3f-8491-25be1a4cf324","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/remove"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"error\": \"Error: Not authorized to perform this action.\"\r\n}"}],"_postman_id":"96a429ef-717b-42fa-81fc-5807c7550979"},{"name":"/api/account/webinar/clone","id":"99244472-21e6-4ff4-bbc1-9023f5461104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/clone","description":"<p>Deep-copies a webinar from the main account into the subaccount as<br />an independent document. Creates fresh analytics and chat history,<br />resets counters, and sets the subaccount as the owner. Returns the<br />new webinar_id.</p>\n<p>Requires a white_label_enabled main account.</p>\n<h2 id=\"body-field-descriptions\"><strong>Body</strong> field descriptions</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>subaccount_email</code></td>\n<td>Email of the subaccount (must be owned by the main account)</td>\n</tr>\n<tr>\n<td><code>webinar_id</code></td>\n<td>ID of the webinar on the main account</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"error-codes\"><strong>Error codes</strong></h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>When</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>400</code></td>\n<td>Missing <code>webinar_id</code>, <code>subaccount_email</code>, or Bearer token</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>Invalid API key / account not <code>white_label_enabled</code> / webinar doesn't belong to main account / subaccount not owned by main account</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>No account found with that <code>subaccount_email</code> (assign &amp; clone also return 404 if webinar not found)</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>Server/DB error</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","account","webinar","clone"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"998268a3-14cf-4c57-84ae-db2236e50a00","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/clone"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"message\": \"Webinar successfully cloned to subaccount.\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}"},{"id":"d723d7b9-4c7f-434c-869e-32ce7ea2fb76","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"subaccount_email\": \"example@email.com\",\r\n  \"webinar_id\": \"123456789qwerty\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/account/webinar/clone"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"error\": \"Error: Not authorized to perform this action.\"\r\n}"}],"_postman_id":"99244472-21e6-4ff4-bbc1-9023f5461104"}],"id":"e961e95b-bb87-48b5-b988-c1738ab15094","description":"<p>WebinarKit's Account API. This API is for White Label customers. It allows the user to create, retrieve, update, and delete accounts (belonging to the main/owner White Label account). In order to use this API, you'll need to include your API key with each request.</p>\n<p>You can generate/find your API key in the settings page of your WebinarKit account.</p>\n","_postman_id":"e961e95b-bb87-48b5-b988-c1738ab15094"},{"name":"Webinars","item":[{"name":"/api/webinars","id":"31a536ea-5a5a-4b22-8523-4b69b79afce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"}],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"example@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/webinars","description":"<p>Get the webinars of the WebinarKit account (who owns the API key). The webinars returned will contain some basic information about each webinar such as the ID, name, type (live or automated), and, if the webinar belongs to a series, the series ID.</p>\n<p>You can optionally pass a subaccount's email via the \"subaccount\" query parameter to retrieve that subaccount's webinars (provided the subaccount is owned by the main account).</p>\n","urlObject":{"protocol":"https","path":["api","webinars"],"host":["webinarkit","com"],"query":[],"variable":[]}},"response":[{"id":"09eb4455-3cee-4bfe-9d7b-ce49ae75e8e7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"example@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://webinarkit.com/api/webinars","protocol":"https","host":["webinarkit","com"],"path":["api","webinars"],"query":[{"key":"subaccount","value":"example@email.com","description":"Pass the email of a subaccount (owned by the main account) to retrieve that subaccount's webinars","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"results\": [\n        {\n            \"id\": \"5d687beb1234540017a18d0e\",\n            \"name\": \"My first webinar\",\n            \"type\": \"automated\",\n            \"series\": \"\"\n        },\n        {\n            \"id\": \"5d6d992e12345d001785698e\",\n            \"name\": \"My second webinar\",\n            \"type\": \"live\",\n            \"series\": \"63997e43f17b603facca5caf\"\n        }\n    ]\n}"},{"id":"4da47cd1-1f47-4b3f-8318-31a34f5156da","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"bad_example@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/webinars"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error loading webinars.\"\n}"}],"_postman_id":"31a536ea-5a5a-4b22-8523-4b69b79afce7"},{"name":"/api/webinar/registration/:id","id":"4eb04d17-042d-4026-8b2d-bc972f442ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\",\n    \"firstName\": \"First\",\n    \"lastName\": \"Last\",\n    \"phoneNumberCountryCode\": \"+1\",\n    \"phoneNumber\": \"123456789\",\n    \"customField1\": \"Custom field 1\",\n    \"customField2\": \"Custom field 2\",\n    \"customField3\": \"Custom field 3\",\n    \"customField4\": \"Custom field 4\",\n    \"customField5\": \"Custom field 5\",\n    \"date\": \"2025-06-22T02:45:00.000Z\",\n    \"fullDate\": \"Wednesday, June 22nd at 10:45 PM ET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/webinar/registration/:id","description":"<p>Register someone for a webinar. The required fields are the webinar ID (passed as a path parameter) and date (the date/time of the webinar session).</p>\n<p>You can also optionally pass the \"<strong>fullDate</strong>\" (the human readable version of the webinar session date, used in things like reminder emails and text messages). If you leave this field blank, WebinarKit will automatically generate a human readable version of the date for you/your registrants.</p>\n<p>If you also pass in the \"<strong>timeZone</strong>\" field when NOT passing the \"<strong>fullDate</strong>\" field, our system will automatically generate the human readable version of the date in the supplied time zone. For a full list of supported time zones, please see the following article: <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>\n<p>This endpoint will ignore registration fields marked as required when using WebinarKit's registration page editor (it assumes you are passing exactly the data that you want the registrant to have).</p>\n<p>The webinar ID can be retrieved using the list webinars endpoint (/api/webinars) or manually retrieving the webinar ID from the URLs for each webinar on webinarkit.com</p>\n<p>The \"<strong>date</strong>\" field parameter accepts a variety of inputs:</p>\n<p><strong>Passing date/times retrieved from the /api/webinar/dates/:id endpoint:</strong></p>\n<p>If you are using the /api/webinar/dates/:id endpoint, you can take the value of the \"<strong>id</strong>\" field from one of the returned array items and send that in the \"<strong>date</strong>\" field of this registration endpoint. This supports all of WebinarKit's scheduling options including \"specific\" date/times, \"ongoing\" date/times, \"just-in-time\" date/times, and \"instant\" sessions.</p>\n<p>For \"ongoing\" sessions, WebinarKit will register the person for the next earliest available session. For example, if your \"ongoing\" date/time for this webinar is every Friday at 2 PM ET, this person will be registered for the earliest Friday session at 2 PM ET.</p>\n<p>For \"instant\" sessions, our system will register the person with their session time set to the current time. For convenience, you can avoid using the /api/webinar/dates/:id endpoint to retrieve the list of dates, and just pass \"instant\" into the \"date\" field to register someone for an instant session.</p>\n<p>For \"just-in-time\" sessions, WebinarKit supports session start times rounded to the nearest 5 minute, 10 minute, or 15 minute marks of each hour. For convenience, you can avoid using the /api/webinar/dates/:id endpoint to retrieve the list of dates, and just pass \"jit_5\", \"jit_10\", or \"jit_15\" into the \"date\" field to register someone for the desired just-in-time session.</p>\n<p><strong>Passing arbitrary date/times:</strong></p>\n<p>For convenience, this endpoint allows you to pass any arbitrary date, even if it is not in the list of dates returned from the /api/webinar/dates/:id endpoint. Essentially, this means you can register anyone for any date/time you wish.</p>\n<p>If you are passing an arbitrary date/time, make sure it is in the ISO 8601 format. You can learn more about that here: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString\">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString</a></p>\n<p>Upon a successful registration, the response returns the registrant's unique webinar session URL, which takes them to the thank you page (either the built-in WebinarKit thank you page or a custom thank you page as specified in the webinar's settings). The registrant will also be enrolled in any email / text notifications &amp; automations as specified in the webinar's settings.</p>\n<p>The response also returns the registration date (the time the registration occured) and the human readable presentation date for convenience.</p>\n","urlObject":{"protocol":"https","path":["api","webinar","registration",":id"],"host":["webinarkit","com"],"query":[],"variable":[{"type":"any","value":"[webinar_id]","key":"id"}]}},"response":[{"id":"8d526b27-c327-498a-a22d-20e283f6a1f1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","name":"Content-Type","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\",\n    \"firstName\": \"First\",\n    \"lastName\": \"Last\",\n    \"phoneNumberCountryCode\": \"+1\",\n    \"phoneNumber\": \"123456789\",\n    \"customField1\": \"Custom field 1\",\n    \"customField2\": \"Custom field 2\",\n    \"customField3\": \"Custom field 3\",\n    \"customField4\": \"Custom field 4\",\n    \"customField5\": \"Custom field 5\",\n    \"date\": \"2025-06-22T02:45:00.000Z\",\n    \"fullDate\": \"Wednesday, June 22nd at 10:45 PM ET\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://webinarkit.com/api/webinar/registration/:id","protocol":"https","host":["webinarkit","com"],"path":["api","webinar","registration",":id"],"variable":[{"key":"id","value":"[webinar_id]"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"url\": \"https://webinarkit.com/webinar/thankyou/5d687beb805ba40017a18d0e/?t=1750560300000&r=62f16ec2945cb5dd7465c0bb\",\n    \"presentationDate\": \"Wednesday, June 22nd at 10:45 PM ET\",\n    \"registrationDate\": \"Monday, August 8, 4:14 PM EDT\"\n}"},{"id":"d9520bfc-b3ae-49d6-b10b-9a37247e3eac","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"example@email.com\",\n    \"firstName\": \"First\",\n    \"lastName\": \"Last\",\n    \"phoneNumberCountryCode\": \"+1\",\n    \"phoneNumber\": \"123456789\",\n    \"customField1\": \"Custom field 1\",\n    \"customField2\": \"Custom field 2\",\n    \"customField3\": \"Custom field 3\",\n    \"customField4\": \"Custom field 4\",\n    \"customField5\": \"Custom field 5\",\n    \"date\": \"2025-06-22T02:45:00.000Z\",\n    \"fullDate\": \"Wednesday, June 22nd at 10:45 PM ET\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://webinarkit.com/api/webinar/registration/:id","protocol":"https","host":["webinarkit","com"],"path":["api","webinar","registration",":id"],"variable":[{"key":"id","value":"[webinar_id]"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error registering for webinar.\"\n}"}],"_postman_id":"4eb04d17-042d-4026-8b2d-bc972f442ae0"},{"name":"/api/webinar/dates/:id","id":"033f7d11-dcd3-4130-b41b-7eee4d4f28d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"url":"https://webinarkit.com/api/webinar/dates/:id","description":"<p>Get the scheduled session date/times of a webinar. This endpoint returns the \"specific\" session date/times (Example: Webinar scheduled for July 5th, 2025 @ 3 PM Eastern) and also the \"ongoing\" session date/times (Example: Webinars scheduled for every Thursday @ 4 PM Eastern).</p>\n<p>In addition, this endpoint also returns the various \"instant\" and \"just-in-time\" options (even if they are not added within the webinar's schedule) that you can pass in webinar registration requests.</p>\n","urlObject":{"protocol":"https","path":["api","webinar","dates",":id"],"host":["webinarkit","com"],"query":[],"variable":[{"type":"any","value":"[webinar_id]","key":"id"}]}},"response":[{"id":"fa5160d1-1e79-4145-9869-513866900371","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"url":{"raw":"https://webinarkit.com/api/webinar/dates/:id","protocol":"https","host":["webinarkit","com"],"path":["api","webinar","dates",":id"],"variable":[{"key":"id","value":"[webinar_id]"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"results\": [\n        {\n            \"id\": \"2022-06-22T02:45:00.000Z\",\n            \"label\": \"2022-06-22 10:45 PM America/New_York\"\n        },\n        {\n            \"id\": \"{\\\"type\\\":\\\"ongoing\\\",\\\"day\\\":\\\"Day\\\",\\\"time\\\":\\\"12:00\\\",\\\"period\\\":\\\"PM\\\",\\\"timeZone\\\":\\\"America/New_York\\\",\\\"id\\\":\\\"1659988399567\\\"}\",\n            \"label\": \"Every Day 12:00 PM America/New_York\"\n        },\n        {\n            \"id\": \"instant\",\n            \"label\": \"Instant session\"\n        },\n        {\n            \"id\": \"jit_5\",\n            \"label\": \"Just-in-time session (Within 5 minutes)\"\n        },\n        {\n            \"id\": \"jit_10\",\n            \"label\": \"Just-in-time session (Within 10 minutes)\"\n        },\n        {\n            \"id\": \"jit_15\",\n            \"label\": \"Just-in-time session (Within 15 minutes)\"\n        }\n    ]\n}"},{"id":"3aef1651-95fe-47f8-b3d1-8d17d536a4c1","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]","type":"text"}],"url":{"raw":"https://webinarkit.com/api/webinar/dates/:id","protocol":"https","host":["webinarkit","com"],"path":["api","webinar","dates",":id"],"variable":[{"key":"id","value":"[webinar_id]"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error: No webinar with ID exists.\"\n}"}],"_postman_id":"033f7d11-dcd3-4130-b41b-7eee4d4f28d1"}],"id":"c7925070-a595-4fb2-ae68-630620db9ed6","description":"<p>WebinarKit's Webinars API. This API allows the user to retrieve webinars and create webinar registrants. In order to use this API, you'll need to include your API key with each request.</p>\n<p>You can generate/find your API key in the settings page of your WebinarKit account.</p>\n","_postman_id":"c7925070-a595-4fb2-ae68-630620db9ed6"},{"name":"Series","item":[{"name":"/api/series","id":"ab233ade-d88f-478e-b715-0025020035a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"}],"url":"https://webinarkit.com/api/series","description":"<p>Get the series of the WebinarKit account (who owns the API key). Each series returned will contain a list of the webinar IDs belonging to the series.</p>\n<p>You can optionally pass a subaccount's email via the \"subaccount\" query parameter to retrieve that subaccount's series (provided the subaccount is owned by the main account).</p>\n","urlObject":{"protocol":"https","path":["api","series"],"host":["webinarkit","com"],"query":[{"disabled":true,"description":{"content":"<p>Optional: Pass in the email of a subaccount (owned by the main account) to retrieve that subaccount's series.</p>\n","type":"text/plain"},"key":"subaccount","value":"example@email.com"}],"variable":[]}},"response":[{"id":"fd3d1d13-7fec-4e6b-b1f1-aec98135c98e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://webinarkit.com/api/series?subaccount=example@email.com","protocol":"https","host":["webinarkit","com"],"path":["api","series"],"query":[{"key":"subaccount","value":"example@email.com","description":"Optional: Pass in the email of a subaccount (owned by the main account) to retrieve that subaccount's series."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"results\": [\n        {\n            \"id\": \"5d687beb1234540017a18d0e\",\n            \"name\": \"My first series\",\n            \"webinars\": [\n                \"656d39b529399cbb0a57aacb\",\n                \"656d3b2229399cbb0a57abb4\",\n                \"656d3b2929399cbb0a57abc9\"\n            ]\n\n        },\n        {\n            \"id\": \"5d6d992e12345d001785698e\",\n            \"name\": \"My second series\",\n            \"webinars\": []\n        }\n    ]\n}"},{"id":"4b1260e2-eb37-411a-92d1-174241bdb0d0","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"example@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webinarkit.com/api/series"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error loading webinars.\"\n}"}],"_postman_id":"ab233ade-d88f-478e-b715-0025020035a3"}],"id":"a2e830bf-1401-4d7e-9f65-eb249bea5ffc","description":"<p>WebinarKit's Webinars API. This API allows the user to retrieve series. In order to use this API, you'll need to include your API key with each request.</p>\n<p>You can generate/find your API key in the settings page of your WebinarKit account.</p>\n","_postman_id":"a2e830bf-1401-4d7e-9f65-eb249bea5ffc"},{"name":"Meetings","item":[{"name":"/api/meetings","id":"c11768db-8f37-40fa-8109-61ee3766aa5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"}],"url":"https://webinarkit.com/api/meetings","description":"<p>Get the meetings of the WebinarKit account (who owns the API key).</p>\n<p>You can optionally pass a subaccount's email via the \"subaccount\" query parameter to retrieve that subaccount's meetings (provided the subaccount is owned by the main account).</p>\n","urlObject":{"protocol":"https","path":["api","meetings"],"host":["webinarkit","com"],"query":[{"disabled":true,"description":{"content":"<p>Optional: Pass in the email of a subaccount (owned by the main account) to retrieve that subaccount's meetings.</p>\n","type":"text/plain"},"key":"subaccount","value":"example@email.com"}],"variable":[]}},"response":[{"id":"b3648c64-1fd5-4f5a-961a-939724813d61","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"}],"url":"https://webinarkit.com/api/meetings"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"results\": [\n        {\n            \"id\": \"5d687beb1234540017a18d0e\",\n            \"name\": \"My first meeting\"\n        },\n        {\n            \"id\": \"5d6d992e12345d001785698e\",\n            \"name\": \"My second meeting\"\n        }\n    ]\n}"},{"id":"87ea3d50-34a1-4615-9c6a-8dce0aabf4a7","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [api_key]"}],"url":"https://webinarkit.com/api/meetings"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Error loading meetings.\"\n}"}],"_postman_id":"c11768db-8f37-40fa-8109-61ee3766aa5a"}],"id":"3ed9431c-b109-4980-a0e5-3bfb8621b259","description":"<p>WebinarKit's Meetings API. This API allows the user to retrieve meetings and create meeting registrants (functionality coming in the future). In order to use this API, you'll need to include your API key with each request.</p>\n<p>You can generate/find your API key in the settings page of your WebinarKit account.</p>\n","_postman_id":"3ed9431c-b109-4980-a0e5-3bfb8621b259"}],"variable":[{"id":"22c477e5-4cc1-49b0-9383-5c822ee55510","key":"baseUrl","value":"/","type":"string"}]}