{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Envelope API Docs","colors":{"primary":"#19A43A","light":"#19A43A","dark":"#19A43A"},"logo":{"light":"https://mintcdn.com/envelope/Iy5_ma1UiDw-TSB_/logo/light.svg?fit=max\u0026auto=format\u0026n=Iy5_ma1UiDw-TSB_\u0026q=85\u0026s=f40fd8ded1c2bc885683ecd3fb914d5c","dark":"https://mintcdn.com/envelope/Iy5_ma1UiDw-TSB_/logo/dark.svg?fit=max\u0026auto=format\u0026n=Iy5_ma1UiDw-TSB_\u0026q=85\u0026s=1fc1d82518ddc50353fdc311e7746b37"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:support@envelope.so","label":"Support"}],"primary":{"type":"button","label":"Website","href":"https://envelope.so"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/envelope-hq"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://attendu.notion.site/envelope-kb"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"envelope","hasAudioNarration":false,"actualSubdomain":"envelope","customDomains":["docs.envelope.so"],"gitSource":{"type":"github","owner":"attendu","repo":"envelope-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21abc2666f2050266695a3","collectionId":"e6e3f7a7-e784-4508-8af2-7df181a9b273","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae94107d279cbf04ccd987f:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"Guests","count":7},{"language":"default","tag":"Events","count":2},{"language":"default","tag":"Get Started","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-docs/guests/register-guest","slug":"/api-docs/guests/register-guest","pageMetadata":{"title":"Register a guest","openapi":"openapi.json post /v1/guests/register","description":"Registers a new guest or confirms an existing guest through a public form submission.","href":"/api-docs/guests/register-guest","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Registers a new guest or confirms an existing guest through a public form submission.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Register a guest","openapi":"openapi.json post /v1/guests/register","description":"Registers a new guest or confirms an existing guest through a public form submission.","href":"/api-docs/guests/register-guest","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Register a guest","tags":["Guests"],"description":"Registers a new guest or confirms an existing guest through a public form submission.","requestBody":"734b446d-a4b5-4c4c-aebb-dc1ed311d2f1","responses":{"200":"5c78d17f-4112-43c7-adb0-978e2f863938","400":"91a27567-5ffa-461e-b328-737d5945c24a","403":"f4ff3869-e795-4ae0-bd8c-b27eadb319eb","404":"a851c36b-9510-423d-8d32-98a40c7ea7ce"},"method":"post","type":"path","servers":["2569fd76-5c89-44c3-9788-0eb185c37e84"],"security":["55132ea7-4d96-4c6f-a02e-0525582969cd"],"path":"/v1/guests/register","baseUrlOptions":["https://envelope.so/api"],"title":"Register a guest","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["eventId","formData"],"properties":{"eventId":{"type":"string","description":"ID of the event","isRequired":true,"uniqueKey":"eventId","typeLabel":"string"},"formData":{"type":"object","required":["properties"],"properties":{"properties":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the guest","isRequired":true,"uniqueKey":"formData.properties.email","typeLabel":"string"},"firstName":{"type":"string","description":"First name of the guest","uniqueKey":"formData.properties.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the guest","uniqueKey":"formData.properties.lastName","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"formData.properties","typeLabel":"object"},"partners":{"type":"integer","description":"Number of additional guests (+1, +2)","minimum":0,"maximum":2,"uniqueKey":"formData.partners","typeLabel":"integer"},"givenConsents":{"type":"array","items":{"type":"string","uniqueKey":"formData.givenConsents.items.[INDEX]","typeLabel":"string"},"description":"Array of consent IDs that the guest has given","uniqueKey":"formData.givenConsents","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"formData","typeLabel":"object"},"guestId":{"type":"string","description":"ID of existing guest if updating","uniqueKey":"guestId","typeLabel":"string"},"pageId":{"type":"string","description":"ID of the page containing the form","uniqueKey":"pageId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"eventId":"\u003cstring>","formData":{"properties":{"email":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>"},"partners":1,"givenConsents":["\u003cstring>"]},"guestId":"\u003cstring>","pageId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5c78d17f-4112-43c7-adb0-978e2f863938":{"description":"Guest registered successfully.","content":{"application/json":{"schema":{"type":"object","required":["_id","event","status","properties"],"properties":{"_id":{"type":"string","description":"Guest ID","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"event":{"type":"string","description":"Event ID","isRequired":true,"uniqueKey":"event","typeLabel":"string"},"status":{"type":"object","required":["confirmation","attendance","givenConsents","visitedZones"],"description":"Guest status information including confirmation, attendance, consents and check-in details","properties":{"confirmation":{"type":"integer","description":"-1 = declined, \n 0 = default, \n 1 = confirmed, \n 2 = confirmed + 1 partner, \n 3 = confirmed + 2 partners","default":0,"isRequired":true,"uniqueKey":"status.confirmation","typeLabel":"integer"},"attendance":{"type":"integer","description":"0 = default, \n 1 = attended, \n 2 = attended + 1 partner, \n 3 = attended + 2 partners","default":0,"isRequired":true,"uniqueKey":"status.attendance","typeLabel":"integer"},"givenConsents":{"type":"array","items":{"type":"string","uniqueKey":"status.givenConsents.items.[INDEX]","typeLabel":"string"},"description":"Array of consents that the guest has given","default":[],"isRequired":true,"uniqueKey":"status.givenConsents","typeLabel":"string[]"},"visitedZones":{"type":"array","items":{"type":"string","uniqueKey":"status.visitedZones.items.[INDEX]","typeLabel":"string"},"description":"Array of zone IDs that the guest has visited","default":[],"isRequired":true,"uniqueKey":"status.visitedZones","typeLabel":"string[]"},"declineMessage":{"oneOf":[{"type":"string","description":"Message from the guest when they declined the invitation","uniqueKey":"status.declineMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message from the guest when they declined the invitation","uniqueKey":"status.declineMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.declineMessage","typeLabel":"string | null"},"addMethod":{"type":"string","enum":["batchImport","singleAdd","checkInAdd","publicRegistration"],"description":"Method used to add the guest to the event","uniqueKey":"status.addMethod","typeLabel":"enum\u003cstring>"},"checkInMethod":{"oneOf":[{"type":"string","enum":["qrScan","manual"],"description":"Method used to check in the guest","uniqueKey":"status.checkInMethod.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["qrScan","manual"],"description":"Method used to check in the guest","uniqueKey":"status.checkInMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.checkInMethod","typeLabel":"enum\u003cstring> | null"}},"example":{"confirmation":2,"attendance":1,"declineMessage":null,"givenConsents":[],"visitedZones":[],"addMethod":"publicRegistration","checkInMethod":"qrScan"},"isRequired":true,"uniqueKey":"status","typeLabel":"object"},"properties":{"type":"object","required":["firstName","lastName","email","lang"],"description":"Guest properties including default required fields and any custom properties defined for the event","properties":{"firstName":{"type":"string","description":"First name of the guest","isRequired":true,"uniqueKey":"properties.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the guest","isRequired":true,"uniqueKey":"properties.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email address of the guest","isRequired":true,"uniqueKey":"properties.email","typeLabel":"string"},"lang":{"type":"string","description":"Language of the guest","isRequired":true,"uniqueKey":"properties.lang","typeLabel":"string"}},"example":{"firstName":"John","lastName":"Doe","email":"john@example.com","lang":"en","X62TkjiV":"My custom note","yN9hzaCj":"1QLXYBlw","Ybb48GO7":["7bR7m2au","BdwYyYmi"]},"isRequired":true,"uniqueKey":"properties","typeLabel":"object"},"confirmedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time when the guest was confirmed","uniqueKey":"confirmedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time when the guest was confirmed","uniqueKey":"confirmedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"confirmedAt","typeLabel":"string\u003cdate-time> | null"},"attendedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time when the guest attended the event","uniqueKey":"attendedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time when the guest attended the event","uniqueKey":"attendedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"attendedAt","typeLabel":"string\u003cdate-time> | null"},"starred":{"type":"boolean","default":false,"description":"Indicates if the guest is starred","uniqueKey":"starred","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","event":"\u003cstring>","status":{"confirmation":2,"attendance":1,"declineMessage":null,"givenConsents":[],"visitedZones":[],"addMethod":"publicRegistration","checkInMethod":"qrScan"},"properties":{"firstName":"John","lastName":"Doe","email":"john@example.com","lang":"en","X62TkjiV":"My custom note","yN9hzaCj":"1QLXYBlw","Ybb48GO7":["7bR7m2au","BdwYyYmi"]},"confirmedAt":"2023-11-07T05:31:56Z","attendedAt":"2023-11-07T05:31:56Z","starred":false}}},"exampleType":"generated"}},"exampleType":"generated"},"91a27567-5ffa-461e-b328-737d5945c24a":{"description":"Invalid request parameters or registration constraints not met.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"integer","example":400,"uniqueKey":"error","typeLabel":"integer"},"message":{"type":"string","example":"Guest email is required","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":400,"message":"Guest email is required"}}},"exampleType":"generated"}},"exampleType":"generated"},"f4ff3869-e795-4ae0-bd8c-b27eadb319eb":{"description":"Event is full or registration not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"integer","example":403,"uniqueKey":"error","typeLabel":"integer"},"message":{"type":"string","example":"Event is full","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":403,"message":"Event is full"}}},"exampleType":"generated"}},"exampleType":"generated"},"a851c36b-9510-423d-8d32-98a40c7ea7ce":{"description":"Event, guest, or form section not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"integer","example":404,"uniqueKey":"error","typeLabel":"integer"},"message":{"type":"string","example":"Event not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":404,"message":"Event not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"55132ea7-4d96-4c6f-a02e-0525582969cd":{"api_key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"2569fd76-5c89-44c3-9788-0eb185c37e84":{"url":"https://envelope.so/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"x-api-key"}],"title":"api_key"}]},"originalFileLocation":"openapi.json"},"subdomain":"envelope","siteName":"Envelope API Docs","title":"Register a guest - Envelope API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-docs/guests/register-guest.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Registers a new guest or confirms an existing guest through a public form submission.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Envelope API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Register a guest - Envelope API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a new guest or confirms an existing guest through a public form submission.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Envelope API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.envelope.so/api-docs/guests/register-guest\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://envelope.mintlify.app/_mintlify/api/og/v2?division=Guests\u0026amp;title=Register+a+guest\u0026amp;description=Registers+a+new+guest+or+confirms+an+existing+guest+through+a+public+form+submission.\u0026amp;theme=eac2d7a1e8eed463c1e8826d\u0026amp;signature=decd83490f4e3adbfb7e1cea2b4da2a3056ca8d17cae11d6ae36b70bb3901a75\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Register a guest - Envelope API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a new guest or confirms an existing guest through a public form submission.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://envelope.mintlify.app/_mintlify/api/og/v2?division=Guests\u0026amp;title=Register+a+guest\u0026amp;description=Registers+a+new+guest+or+confirms+an+existing+guest+through+a+public+form+submission.\u0026amp;theme=eac2d7a1e8eed463c1e8826d\u0026amp;signature=decd83490f4e3adbfb7e1cea2b4da2a3056ca8d17cae11d6ae36b70bb3901a75\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/envelope/UExcoWz1E5pUVfWF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Envelope API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#19A43A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.envelope.so/api-docs/guests/register-guest\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-docs/guests/register-guest.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.envelope.so/#organization\",\"name\":\"Envelope API Docs\",\"url\":\"https://docs.envelope.so\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/envelope/Iy5_ma1UiDw-TSB_/logo/light.svg?fit=max\u0026auto=format\u0026n=Iy5_ma1UiDw-TSB_\u0026q=85\u0026s=f40fd8ded1c2bc885683ecd3fb914d5c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.envelope.so#website\",\"name\":\"Envelope API Docs\",\"url\":\"https://docs.envelope.so\",\"publisher\":{\"@id\":\"https://docs.envelope.so/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.envelope.so/api-docs/guests/register-guest#webpage\",\"url\":\"https://docs.envelope.so/api-docs/guests/register-guest\",\"name\":\"Register a guest\",\"description\":\"Registers a new guest or confirms an existing guest through a public form submission.\",\"isPartOf\":{\"@id\":\"https://docs.envelope.so#website\"},\"breadcrumb\":{\"@id\":\"https://docs.envelope.so/api-docs/guests/register-guest#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.envelope.so/api-docs/guests/register-guest#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Guests\",\"item\":\"https://docs.envelope.so/api-docs/guests/list-guests\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Register a guest\",\"item\":\"https://docs.envelope.so/api-docs/guests/register-guest\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.envelope.so/api-docs/guests/register-guest#apireference\",\"headline\":\"Register a guest\",\"name\":\"Register a guest\",\"description\":\"Registers a new guest or confirms an existing guest through a public form submission.\",\"url\":\"https://docs.envelope.so/api-docs/guests/register-guest\",\"mainEntityOfPage\":{\"@id\":\"https://docs.envelope.so/api-docs/guests/register-guest#webpage\"},\"publisher\":{\"@id\":\"https://docs.envelope.so/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.envelope.so#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Envelope API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Envelope API Docs","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://attendu.notion.site/envelope-kb"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":null,"href":"/introduction"}]},{"group":"Events","pages":[{"title":"List all events","openapi":"openapi.json get /v1/events","href":"/api-docs/events/list-events"},{"title":"Get an event by ID","openapi":"openapi.json get /v1/events/{_id}","href":"/api-docs/events/get-event"}]},{"group":"Guests","pages":[{"title":"List all guests","openapi":"openapi.json get /v1/guests","href":"/api-docs/guests/list-guests"},{"title":"Get a guest by ID","openapi":"openapi.json get /v1/guests/{_id}","href":"/api-docs/guests/get-guest"},{"title":"Create a new guest","openapi":"openapi.json post /v1/guests","href":"/api-docs/guests/create-guest"},{"title":"Update a guest","openapi":"openapi.json patch /v1/guests/{_id}","description":"Updates guest information with partial modifications.","href":"/api-docs/guests/update-guest"},{"title":"Register a guest","openapi":"openapi.json post /v1/guests/register","href":"/api-docs/guests/register-guest"},{"title":"Check in a guest","openapi":"openapi.json post /v1/guests/{_id}/check-in","description":"Records guest attendance by checking them in to the event or specific zone.","href":"/api-docs/guests/check-in"},{"title":"Remove guest check-in","openapi":"openapi.json delete /v1/guests/{_id}/check-in","href":"/api-docs/guests/check-in-remove"}]}]}]},"basePath":"","title":"Register a guest - Envelope API Docs","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}