Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.
POST
/
v1
/
invites
cURL
curl --request POST \ --url https://api.claap.io/v1/invites \ --header 'Content-Type: application/json' \ --header 'X-Claap-Key: <api-key>' \ --data '{ "emails": [ "jane.doe@example.com", "john.smith@example.com", "alex.martin@example.com" ], "role": "Member", "message": "Welcome to the team!"}'
Invites up to 50 people to the workspace by email. The invite email is sent on behalf of the person who created the API key.Each email gets its own outcome:
invited: an invite was created, the user joins the workspace when they accept it.
added: the email already has a Claap account, the user was added to the workspace right away.
already_member: the email is already an active user of the workspace.
failed: the email could not be invited, for instance because it is not valid, the user is suspended, or the invite limit is reached for that workspace. error explains why.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Claap API","description":"Claap API documentation","colors":{"primary":"#FF5A81","light":"#FF5A81","dark":"#FF5A81"},"logo":{"light":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda","dark":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda"},"favicon":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/favicon.ico?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=5364cc1bba934c12994999c57de9f134","navbar":{"links":[{"href":"https://help.claap.io","label":"Claap Help Center"},{"href":"mailto:support@claap.io","label":"Support"},{"href":"https://www.claap.io/contact","label":"Book a demo"}]},"footer":{"socials":{"website":"https://claap.io","linkedin":"https://www.linkedin.com/company/claap-io","slack":"https://join.slack.com/t/firstclaapers/shared_invite/zt-qtel9fc0-sSyLA9M2higrtd4nwF6Hcw","x":"https://twitter.com/claap_io","youtube":"https://www.youtube.com/@claap_io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"claap","hasAudioNarration":false,"actualSubdomain":"claap","customDomains":["docs.claap.io"],"gitSource":{"type":"github","owner":"claap-app","repo":"api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6adb0e66ee97d2ce49edde83","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API reference","count":96},{"language":"default","tag":"Recording","count":22},{"language":"default","tag":"Deal","count":21},{"language":"default","tag":"Company","count":14},{"language":"default","tag":"Contact","count":11},{"language":"default","tag":"Getting started","count":8},{"language":"default","tag":"Admin automation","count":5},{"language":"default","tag":"Folder","count":4},{"language":"default","tag":"Invite","count":4},{"language":"default","tag":"User group","count":4}]},"assistantConfig":{},"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":"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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/post_invite","slug":"/api-reference/endpoint/post_invite","pageMetadata":{"title":"Invite users","openapi":"POST /v1/invites","description":"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.","href":"/api-reference/endpoint/post_invite"},"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: \"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Invites up to 50 people to the workspace by email. The invite email is sent on behalf of the person who created the API key.`}),`\n`,_jsxs(_components.p,{children:[`Each email gets its own `,_jsx(_components.code,{children:`outcome`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`invited`}),`: an invite was created, the user joins the workspace when they accept it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`added`}),`: the email already has a Claap account, the user was added to the workspace right away.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`already_member`}),`: the email is already an active user of the workspace.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`failed`}),`: the email could not be invited, for instance because it is not valid, the user is suspended, or the invite limit is reached for that workspace. `,_jsx(_components.code,{children:`error`}),` explains why.`]}),`\n`]})]})}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":"Invite users","openapi":"POST /v1/invites","description":"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.","href":"/api-reference/endpoint/post_invite"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"52cea888-58e8-4e5d-aabc-2937bf1f7325","400":"ef3db774-8bf6-4a5b-b758-dca47b7eeb3d","403":"53408a5b-458f-4653-bea1-a15abadafed9"},"operationId":"postV1Invites","description":"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.","requestBody":"d6375272-1169-4ade-bf86-2b107d08d27a","method":"post","type":"path","servers":["8ee810c4-540f-441a-9f25-6055c9139c4c"],"security":["9666b11d-87f1-4fa8-8ecb-a775921bac48"],"path":"/v1/invites","baseUrlOptions":["https://api.claap.io/"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"emails.items.[INDEX]","typeLabel":"string\u003cemail>"},"minItems":1,"maxItems":50,"description":"Emails to invite.","isRequired":true,"uniqueKey":"emails","typeLabel":"string\u003cemail>[]"},"role":{"type":"string","enum":["Member","Admin","Owner"],"default":"Member","description":"Role given to the invited users. On a workspace without an active subscription, users are always invited as Owner.","uniqueKey":"role","typeLabel":"enum\u003cstring>"},"userGroupIds":{"type":"array","items":{"type":"string","uniqueKey":"userGroupIds.items.[INDEX]","typeLabel":"string"},"description":"User groups the invited users join.","uniqueKey":"userGroupIds","typeLabel":"string[]"},"message":{"type":"string","description":"Personal message added to the invite email.","uniqueKey":"message","typeLabel":"string"}},"required":["emails"],"uniqueKey":"","typeLabel":"object"},"example":{"emails":["jane.doe@example.com","john.smith@example.com","alex.martin@example.com"],"role":"Member","message":"Welcome to the team!"},"examples":{"Example":{"title":"Example","value":{"emails":["jane.doe@example.com","john.smith@example.com","alex.martin@example.com"],"role":"Member","message":"Welcome to the team!"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"52cea888-58e8-4e5d-aabc-2937bf1f7325":{"description":"Invites were processed","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"Invited email.","isRequired":true,"uniqueKey":"result.results.items.[INDEX].email","typeLabel":"string"},"outcome":{"type":"string","enum":["invited","added","already_member","failed"],"description":"\"invited\" when an invite was created, \"added\" when the email has a Claap account in another workspace and was added to the workspace right away, \"already_member\" when the email is already an active user of the workspace, \"failed\" when this email could not be invited.","isRequired":true,"uniqueKey":"result.results.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Why the email could not be invited, set only when the outcome is \"failed\".","uniqueKey":"result.results.items.[INDEX].error","typeLabel":"string"},"userId":{"type":"string","description":"User identifier, set only when the outcome is \"added\" or \"already_member\".","uniqueKey":"result.results.items.[INDEX].userId","typeLabel":"string"}},"required":["email","outcome"],"uniqueKey":"result.results.items.[INDEX]","typeLabel":"object"},"description":"One result per unique email.","isRequired":true,"uniqueKey":"result.results","typeLabel":"object[]"}},"required":["results"],"isRequired":true,"uniqueKey":"result","typeLabel":"object"}},"required":["result"],"uniqueKey":"","typeLabel":"object"},"example":{"result":{"results":[{"email":"jane.doe@example.com","outcome":"invited"},{"email":"john.smith@example.com","outcome":"already_member","userId":"Xk2Rd7Mv4Bn9Ts1Lq6Wf3"},{"email":"alex.martin@example.com","outcome":"failed","error":"Cannot invite suspended user"}]}},"examples":{"Example":{"title":"Example","value":{"result":{"results":[{"email":"jane.doe@example.com","outcome":"invited"},{"email":"john.smith@example.com","outcome":"already_member","userId":"Xk2Rd7Mv4Bn9Ts1Lq6Wf3"},{"email":"alex.martin@example.com","outcome":"failed","error":"Cannot invite suspended user"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"ef3db774-8bf6-4a5b-b758-dca47b7eeb3d":{"description":"The request is not valid. For instance an email is malformed, more than 50 emails are provided, or a user group was not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"53408a5b-458f-4653-bea1-a15abadafed9":{"description":"The invites are not allowed. For instance more than 10 emails are provided and the workspace plan does not allow it, or user editing is restricted by SCIM provisioning.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9666b11d-87f1-4fa8-8ecb-a775921bac48":{"ApiKey":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"}}},"servers":{"8ee810c4-540f-441a-9f25-6055c9139c4c":{"url":"https://api.claap.io/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Claap-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Claap-Key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"claap","siteName":"Claap API","title":"Invite users - Claap API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T07:11:40.087Z","originalFileLocation":"api-reference/endpoint/post_invite.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=\"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Claap API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Invite users - Claap API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Claap API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.claap.io/api-reference/endpoint/post_invite\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://claap.mintlify.site/_mintlify/api/og/v2?division=Invite\u0026amp;title=Invite+users\u0026amp;description=Invite+users+to+the+workspace+by+email.+Each+email+gets+its+own+result%3A+an+email+that+cannot+be+invited+does+not+prevent+the+others+from+being+invited.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=ed090f62bdf345edc1f8eaa63cb0ed33fa12732faafb9adc5f3d4d88dd926903\">\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=\"Invite users - Claap API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://claap.mintlify.site/_mintlify/api/og/v2?division=Invite\u0026amp;title=Invite+users\u0026amp;description=Invite+users+to+the+workspace+by+email.+Each+email+gets+its+own+result%3A+an+email+that+cannot+be+invited+does+not+prevent+the+others+from+being+invited.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=ed090f62bdf345edc1f8eaa63cb0ed33fa12732faafb9adc5f3d4d88dd926903\">\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/claap/gczWElg9AVgfGA_0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Claap API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5A81\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.claap.io/api-reference/endpoint/post_invite\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/post_invite.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.claap.io/#organization\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.claap.io#website\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/post_invite#webpage\",\"url\":\"https://docs.claap.io/api-reference/endpoint/post_invite\",\"name\":\"Invite users\",\"description\":\"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\",\"dateModified\":\"2026-09-24T07:11:40.087Z\",\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/post_invite#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/post_invite#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invite\",\"item\":\"https://docs.claap.io/api-reference/endpoint/list_invites\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invite users\",\"item\":\"https://docs.claap.io/api-reference/endpoint/post_invite\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.claap.io/api-reference/endpoint/post_invite#apireference\",\"headline\":\"Invite users\",\"name\":\"Invite users\",\"description\":\"Invite users to the workspace by email. Each email gets its own result: an email that cannot be invited does not prevent the others from being invited.\",\"url\":\"https://docs.claap.io/api-reference/endpoint/post_invite\",\"mainEntityOfPage\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/post_invite#webpage\"},\"dateModified\":\"2026-09-24T07:11:40.087Z\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Claap API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Claap API","nav":{"global":null,"tabs":[{"tab":"API reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Responses \u0026 Errors","href":"/api-reference/errors"},{"title":"Quotas and Limits","href":"/api-reference/rate_limiting"},{"title":"Recordings Visibility","href":"/api-reference/recordings"},{"title":"Views","href":"/api-reference/views"},{"title":"AI fields","href":"/api-reference/ai_fields"},{"title":"Admin automations","href":"/api-reference/automations"}]},{"group":"Recording","pages":[{"title":"List recordings","openapi":"GET /v1/recordings","href":"/api-reference/endpoint/list_recordings"},{"title":"Get recording details","openapi":"GET /v1/recordings/{recordingId}","href":"/api-reference/endpoint/get_recording"},{"title":"Get recording transcript","openapi":"GET /v1/recordings/{recordingId}/transcript","href":"/api-reference/endpoint/get_recording_transcript"},{"title":"Create recording","openapi":"POST /v1/recordings","href":"/api-reference/endpoint/post_recording"},{"title":"Delete recording","openapi":"DELETE /v1/recordings/{recordingId}","href":"/api-reference/endpoint/delete_recording"},{"title":"List recording views","openapi":"GET /v1/recordings/views","href":"/api-reference/endpoint/list_recording_views"},{"title":"Get recording view details","openapi":"GET /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/get_recording_view"},{"title":"Create recording view","openapi":"POST /v1/recordings/views","href":"/api-reference/endpoint/post_recording_view"},{"title":"Update recording view","openapi":"PATCH /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/patch_recording_view"},{"title":"Delete recording view","openapi":"DELETE /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/delete_recording_view"},{"title":"List pinned recording views","openapi":"GET /v1/recordings/views/pinned","href":"/api-reference/endpoint/list_pinned_recording_views"},{"title":"Update pinned recording views","openapi":"PUT /v1/recordings/views/pinned","href":"/api-reference/endpoint/put_pinned_recording_views"},{"title":"List recording AI fields","openapi":"GET /v1/recordings/fields","href":"/api-reference/endpoint/list_recording_ai_fields"},{"title":"Get recording AI field","openapi":"GET /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/get_recording_ai_field"},{"title":"Create recording AI field","openapi":"POST /v1/recordings/fields","href":"/api-reference/endpoint/post_recording_ai_field"},{"title":"Update recording AI field","openapi":"PUT /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/put_recording_ai_field"},{"title":"Archive recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_recording_ai_field"},{"title":"Generate recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_recording_ai_field"},{"title":"Get recording AI field generation","openapi":"GET /v1/recordings/fields/generations/{generationId}","href":"/api-reference/endpoint/get_recording_ai_field_generation"},{"title":"Cancel recording AI field generation","openapi":"POST /v1/recordings/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_recording_ai_field_generation"}]},{"group":"Deal","pages":[{"title":"List deals","openapi":"GET /v1/deals","href":"/api-reference/endpoint/list_deals"},{"title":"Get deal details","openapi":"GET /v1/deals/{dealId}","href":"/api-reference/endpoint/get_deal"},{"title":"Update deal","openapi":"PATCH /v1/deals/{dealId}","href":"/api-reference/endpoint/patch_deal"},{"title":"List deal stages","openapi":"GET /v1/deals/stages","href":"/api-reference/endpoint/list_deal_stages"},{"title":"List deal types","openapi":"GET /v1/deals/types","href":"/api-reference/endpoint/list_deal_types"},{"title":"List deal owners","openapi":"GET /v1/deals/owners","href":"/api-reference/endpoint/list_deal_owners"},{"title":"List deal views","openapi":"GET /v1/deals/views","href":"/api-reference/endpoint/list_deal_views"},{"title":"Get deal view details","openapi":"GET /v1/deals/views/{viewId}","href":"/api-reference/endpoint/get_deal_view"},{"title":"Create deal view","openapi":"POST /v1/deals/views","href":"/api-reference/endpoint/post_deal_view"},{"title":"Update deal view","openapi":"PATCH /v1/deals/views/{viewId}","href":"/api-reference/endpoint/patch_deal_view"},{"title":"Delete deal view","openapi":"DELETE /v1/deals/views/{viewId}","href":"/api-reference/endpoint/delete_deal_view"},{"title":"List pinned deal views","openapi":"GET /v1/deals/views/pinned","href":"/api-reference/endpoint/list_pinned_deal_views"},{"title":"Update pinned deal views","openapi":"PUT /v1/deals/views/pinned","href":"/api-reference/endpoint/put_pinned_deal_views"},{"title":"List deal AI fields","openapi":"GET /v1/deals/fields","href":"/api-reference/endpoint/list_deal_ai_fields"},{"title":"Get deal AI field","openapi":"GET /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/get_deal_ai_field"},{"title":"Create deal AI field","openapi":"POST /v1/deals/fields","href":"/api-reference/endpoint/post_deal_ai_field"},{"title":"Update deal AI field","openapi":"PUT /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/put_deal_ai_field"},{"title":"Archive deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_deal_ai_field"},{"title":"Generate deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_deal_ai_field"},{"title":"Get deal AI field generation","openapi":"GET /v1/deals/fields/generations/{generationId}","href":"/api-reference/endpoint/get_deal_ai_field_generation"},{"title":"Cancel deal AI field generation","openapi":"POST /v1/deals/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_deal_ai_field_generation"}]},{"group":"Company","pages":[{"title":"List companies","openapi":"GET /v1/companies","href":"/api-reference/endpoint/list_companies"},{"title":"Get company details","openapi":"GET /v1/companies/{companyId}","href":"/api-reference/endpoint/get_company"},{"title":"List company views","openapi":"GET /v1/companies/views","href":"/api-reference/endpoint/list_company_views"},{"title":"Get company view details","openapi":"GET /v1/companies/views/{viewId}","href":"/api-reference/endpoint/get_company_view"},{"title":"Create company view","openapi":"POST /v1/companies/views","href":"/api-reference/endpoint/post_company_view"},{"title":"Update company view","openapi":"PATCH /v1/companies/views/{viewId}","href":"/api-reference/endpoint/patch_company_view"},{"title":"Delete company view","openapi":"DELETE /v1/companies/views/{viewId}","href":"/api-reference/endpoint/delete_company_view"},{"title":"List pinned company views","openapi":"GET /v1/companies/views/pinned","href":"/api-reference/endpoint/list_pinned_company_views"},{"title":"Update pinned company views","openapi":"PUT /v1/companies/views/pinned","href":"/api-reference/endpoint/put_pinned_company_views"},{"title":"List company AI fields","openapi":"GET /v1/companies/fields","href":"/api-reference/endpoint/list_company_ai_fields"},{"title":"Get company AI field","openapi":"GET /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/get_company_ai_field"},{"title":"Create company AI field","openapi":"POST /v1/companies/fields","href":"/api-reference/endpoint/post_company_ai_field"},{"title":"Update company AI field","openapi":"PUT /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/put_company_ai_field"},{"title":"Archive company AI field","openapi":"POST /v1/companies/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_company_ai_field"}]},{"group":"Contact","pages":[{"title":"List contacts","openapi":"GET /v1/contacts","href":"/api-reference/endpoint/list_contacts"},{"title":"Get contact details","openapi":"GET /v1/contacts/{contactId}","href":"/api-reference/endpoint/get_contact"},{"title":"Create contact","openapi":"POST /v1/contacts","href":"/api-reference/endpoint/post_contact"},{"title":"Update contact","openapi":"PATCH /v1/contacts/{contactId}","href":"/api-reference/endpoint/patch_contact"},{"title":"List contact views","openapi":"GET /v1/contacts/views","href":"/api-reference/endpoint/list_contact_views"},{"title":"Get contact view details","openapi":"GET /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/get_contact_view"},{"title":"Create contact view","openapi":"POST /v1/contacts/views","href":"/api-reference/endpoint/post_contact_view"},{"title":"Update contact view","openapi":"PATCH /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/patch_contact_view"},{"title":"Delete contact view","openapi":"DELETE /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/delete_contact_view"},{"title":"List pinned contact views","openapi":"GET /v1/contacts/views/pinned","href":"/api-reference/endpoint/list_pinned_contact_views"},{"title":"Update pinned contact views","openapi":"PUT /v1/contacts/views/pinned","href":"/api-reference/endpoint/put_pinned_contact_views"}]},{"group":"Folder","pages":[{"title":"Get folder details","openapi":"GET /v1/folders/{folderId}","href":"/api-reference/endpoint/get_folder"},{"title":"Create folder","openapi":"POST /v1/folders","href":"/api-reference/endpoint/post_folder"},{"title":"Update folder","openapi":"PATCH /v1/folders/{folderId}","href":"/api-reference/endpoint/patch_folder"},{"title":"Delete folder","openapi":"DELETE /v1/folders/{folderId}","href":"/api-reference/endpoint/delete_folder"}]},{"group":"Admin automation","pages":[{"title":"List admin automations","openapi":"GET /v1/admin-automations","href":"/api-reference/endpoint/list_admin_automations"},{"title":"Get admin automation","openapi":"GET /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/get_admin_automation"},{"title":"Create admin automation","openapi":"POST /v1/admin-automations","href":"/api-reference/endpoint/post_admin_automation"},{"title":"Update admin automation","openapi":"PUT /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/put_admin_automation"},{"title":"Delete admin automation","openapi":"DELETE /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/delete_admin_automation"}]},{"group":"Workspace","pages":[{"title":"Get workspace information","openapi":"GET /v1/workspaces/mine","href":"/api-reference/endpoint/get_workspace"}]},{"group":"User","pages":[{"title":"List users","openapi":"GET /v1/users","href":"/api-reference/endpoint/list_users"},{"title":"Get user details","openapi":"GET /v1/users/{userId}","href":"/api-reference/endpoint/get_user"},{"title":"Update user","openapi":"PATCH /v1/users/{userId}","href":"/api-reference/endpoint/patch_user"}]},{"group":"Invite","pages":[{"title":"List invites","openapi":"GET /v1/invites","description":"List the pending invites of the workspace, sorted by email.","href":"/api-reference/endpoint/list_invites"},{"title":"Invite users","openapi":"POST /v1/invites","href":"/api-reference/endpoint/post_invite"},{"title":"Resend invite","openapi":"POST /v1/invites/{email}/resend","description":"Send the invite email of a pending invite again.","href":"/api-reference/endpoint/resend_invite"},{"title":"Cancel invite","openapi":"DELETE /v1/invites/{email}","href":"/api-reference/endpoint/delete_invite"}]},{"group":"User group","pages":[{"title":"List user groups","openapi":"GET /v1/user-groups","href":"/api-reference/endpoint/list_user_groups"},{"title":"Create user group","openapi":"POST /v1/user-groups","href":"/api-reference/endpoint/post_user_group"},{"title":"Update user group","openapi":"PATCH /v1/user-groups/{userGroupId}","href":"/api-reference/endpoint/patch_user_group"},{"title":"Delete user group","openapi":"DELETE /v1/user-groups/{userGroupId}","href":"/api-reference/endpoint/delete_user_group"}]},{"group":"Webhook","pages":[{"title":"Trigger webhook","openapi":"POST /v1/webhooks/{webhookId}/trigger","href":"/api-reference/endpoint/trigger_webhook"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/setup"}]},{"tab":"Webhook reference","pages":[{"title":"Webhook reference","href":"/api-reference/webhooks"}]}]},"basePath":"","title":"Invite users - Claap API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-Dr40SSJq.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}