https://docs.kvantumci.com/assets/js/c9fd6902.82c386f6.js

1"use strict";(globalThis.webpackChunkdocs_temp=globalThis.webpackChunkdocs_temp||[]).push([[3076],{56555(e,t,n){n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>b,default:()=>g,frontMatter:()=>y,metadata:()=>i,toc:()=>W});const i=JSON.parse('{"id":"reference/invitations-controller-send-invitation","title":"Send an invitation email to a new team member","description":"Creates an invitation record and sends a welcome email with an accept link. Automatically detects whether the invitee already has an account and sends the appropriate accept URL. Required permission: `invitations:create`","source":"@site/api-docs/reference/invitations-controller-send-invitation.api.mdx","sourceDirName":"reference","slug":"/reference/invitations-controller-send-invitation","permalink":"/api-docs/reference/invitations-controller-send-invitation","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"invitations-controller-send-invitation","title":"Send an invitation email to a new team member","description":"Creates an invitation record and sends a welcome email with an accept link. Automatically detects whether the invitee already has an account and sends the appropriate accept URL. Required permission: `invitations:create`","sidebar_label":"Send an invitation email to a new team member","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWN1u4zYWfpUDXiWBbG9nOumud7GoJ9NO0xY7wcSDXqTB+Fg6sjihSA1JxXENA32IfYZ9sD7J4pBSJFtBNtn2qrlSyMPz851/b0VGLrWy8tJoMRVnltCTA9Qg9a30yOdgKTU2A9QZONKZA4Q1qdSUBFSiVLCWvuA3mKZUeVBS34xhVntTopcpKrWBjDyl3sG6IF+QBV9QFEEEqCxhtoECXcPF1Nr35DExVpU1lZXoqZXz4f2PY3hPn2tpKYOKbCmdk0ZPYdFp76ZpMGohEmEqsuHwPBNTcd7RnBntrVGK7EeW2N2IRFRosSRP1onp1VZoLElMxd3Ik0btRzITiZAMXkGYkRXJAabzQAfnb0QibKOsmHpbUyJcWlCJYroVflMxW+et1Cux211HYnL+tck2THH4NjXak/Z8hVWlZBoUnnxyLHU7ZG2Wnyj1bJBlHLwkx7fBg0MNEpEbW6IX04ZilwhrFD1EmVGOtQqkeiU1kW2pGedHONe1zMRu18flqhF3nQgvPctrgrLzyRtvxG4Xn7nKaBcNuddie+AA8YdhJZ9iTvIcSGMQPQmmZyDKAcmplb3ePId65nvUIhF3I03Of3IffzHZiMrKb0bxkgNwlwjn0dfuIQmk65J9WZHO4klMWcpCEjC4lLGPu9BpSe/5nhWoV61SulYKl4ra4H+ukg2zp+CRHAjbJSJWkGfjU1dZ9+z/tyAjRX8Am4Ps/X0h/vS4fQBOp+rVAzXvoHAOGQ8YSXdZV2RnWSn7D5bGKEItHnfB48geVqVgyb3VjQ37Gh/o0w+bviJ9sdeHRh240ZHKR50aOSrXuvJfoQ89ASQmvnwQ8QHxQzbHUrVne1OH+lWmX0OGCTzMwieC07aA902hHzYBjkVccWsWqZKk/QgryU9L8oXhNl8ZF8IcfSGmYtKbDFgvsrdtZ6+t4i7ufeWmkwlWcnxzi9rXZSrHqSkHjX12cQ6X4b3gdu0ora30m8DLYO2LF107C2mWS0VxCtEyE9f9R5fcgWIGtk+7TI0HiciVWQcSPjBW/hLMODMZDQ4/7NtS+2LfmEm/DZpJ+5Ym7GlzQ89lEN7wY5eaam+wELM0JefAG9iY2sIhHgOCAVBT8a4iff4GzozWXLOC1w98UfuCtJc38I4/X/D02aEBjBEwfHB08cPZN8fjn/XPepZ7spCaslLkpV6FMTMQ8YclV6tw/P1P8zBxBh1vSIN0PJd6kDpQnpzsCTs5gTgJTlnIYu9uCq8JLVn4x6e1/+ciaKEUkM4qI7V37WTrC+mAQYcYxmOuZVjJUVDgfmQJxS4wFEnz8W1bfC9m88nb2Vzctwj25SCGL8g6o1FB44R5MPDoYjY/BmPhrTLLweXb2TwCeEk6Cwg0sDwOBxw5LKn9B13rqe9/mh8/ClXgHsGKGtyiqslBitZuAKFEnaE3dgOVpVzeTWFRof/426//WUBuLC8G0cbAyCWwWPWvmzl+LbPGEAe//frv6ILIkB1eNGERCwZk0nFs1NIVFPaTEnJryp5NLkD0TqtNz70eVyvK4OSkq1UnJ//T6TfUH1uwkj/QZrB0NHvJrJKjeL3v6MsCeUnimnVDm2B4iWkhNY28GTWfnaZjCM5dNOwWcJSiNpqXueO/w+Ju1Oi1YGxQOQPtgDcOAz1P1u+7/eWbO+Qs65eF2pH9muJ5U17jhNItEd3EK17m+NdX+emXo1dfffHV6MtXpy9Gy5d5OnqR/u30ZX56ijmexkk2NwGrpnF8h+mNLOolnAXA2f4BNPc0DI6rbY4pAd6iDK2R61IMEUDu6y7spay9g6POjT0nG602xyIR3FiihC/Gf2HluBOVGNK38VYAeX/Zjhu1N4CgaQ2esISSyuVws9x2a82ffXFvQt/TnZ9UCmWc7WxYsmJjvxL9xn6diILb/vRKbLdLdPTBqt2Ojz/XZLlFXyfiFq2Mw8/V9S5pM4m7dyYdX7QT1yO4H7VWHEN/z39Q35DGBz8chFLG8/su2TYEZ5H5aM48OorB3tq9mAVUH6XtD0QX7y65LSyb3xXKMD8Ii2tOOFzHbcJUEUn+4YHPtkKhXtW4YtrIk//+Cz3DYA4=","sidebar_class_name":"post api-method","info_path":"api-docs/reference/hackihub-client-api","custom_edit_url":null},"sidebar":"apiDocsSidebar","previous":{"title":"Resend an invitation email by invitation ID","permalink":"/api-docs/reference/invitations-controller-resend-invitation"},"next":{"title":"Update an invitation status by ID","permalink":"/api-docs/reference/invitations-controller-update-invitation"}}');var a=n(74848),r=n(28453),s=n(57742),d=n.n(s),o=n(78178),l=n.n(o),p=n(19624),c=n.n(p),u=n(96226),m=n.n(u),f=(n(77675),n(19365),n(51107)),h=n(21312);const y={id:"invitations-controller-send-invitation",title:"Send an invitation email to a new team member",description:"Creates an invitation record and sends a welcome email with an accept link. Automatically detects whether the invitee already has an account and sends the appropriate accept URL. Required permission: `invitations:create`",sidebar_label:"Send an invitation email to a new team member",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWN1u4zYWfpUDXiWBbG9nOumud7GoJ9NO0xY7wcSDXqTB+Fg6sjihSA1JxXENA32IfYZ9sD7J4pBSJFtBNtn2qrlSyMPz851/b0VGLrWy8tJoMRVnltCTA9Qg9a30yOdgKTU2A9QZONKZA4Q1qdSUBFSiVLCWvuA3mKZUeVBS34xhVntTopcpKrWBjDyl3sG

16IF+QBV9QFEEEqCxhtoECXcPF1Nr35DExVpU1lZXoqZXz4f2PY3hPn2tpKYOKbCmdk0ZPYdFp76ZpMGohEmEqsuHwPBNTcd7RnBntrVGK7EeW2N2IRFRosSRP1onp1VZoLElMxd3Ik0btRzITiZAMXkGYkRXJAabzQAfnb0QibKOsmHpbUyJcWlCJYroVflMxW+et1Cux211HYnL+tck2THH4NjXak/Z8hVWlZBoUnnxyLHU7ZG2Wnyj1bJBlHLwkx7fBg0MNEpEbW6IX04ZilwhrFD1EmVGOtQqkeiU1kW2pGedHONe1zMRu18flqhF3nQgvPctrgrLzyRtvxG4Xn7nKaBcNuddie+AA8YdhJZ9iTvIcSGMQPQmmZyDKAcmplb3ePId65nvUIhF3I03Of3IffzHZiMrKb0bxkgNwlwjn0dfuIQmk65J9WZHO4klMWcpCEjC4lLGPu9BpSe/5nhWoV61SulYKl4ra4H+ukg2zp+CRHAjbJSJWkGfjU1dZ9+z/tyAjRX8Am4Ps/X0h/vS4fQBOp+rVAzXvoHAOGQ8YSXdZV2RnWSn7D5bGKEItHnfB48geVqVgyb3VjQ37Gh/o0w+bviJ9sdeHRh240ZHKR50aOSrXuvJfoQ89ASQmvnwQ8QHxQzbHUrVne1OH+lWmX0OGCTzMwieC07aA902hHzYBjkVccWsWqZKk/QgryU9L8oXhNl8ZF8IcfSGmYtKbDFgvsrdtZ6+t4i7ufeWmkwlWcnxzi9rXZSrHqSkHjX12cQ6X4b3gdu0ora30m8DLYO2LF107C2mWS0VxCtEyE9f9R5fcgWIGtk+7TI0HiciVWQcSPjBW/hLMODMZDQ4/7NtS+2LfmEm/DZpJ+5Ym7GlzQ89lEN7wY5eaam+wELM0JefAG9iY2sIhHgOCAVBT8a4iff4GzozWXLOC1w98UfuCtJc38I4/X/D02aEBjBEwfHB08cPZN8fjn/XPepZ7spCaslLkpV6FMTMQ8YclV6tw/P1P8zBxBh1vSIN0PJd6kDpQnpzsCTs5gTgJTlnIYu9uCq8JLVn4x6e1/+ciaKEUkM4qI7V37WTrC+mAQYcYxmOuZVjJUVDgfmQJxS4wFEnz8W1bfC9m88nb2Vzctwj25SCGL8g6o1FB44R5MPDoYjY/BmPhrTLLweXb2TwCeEk6Cwg0sDwOBxw5LKn9B13rqe9/mh8/ClXgHsGKGtyiqslBitZuAKFEnaE3dgOVpVzeTWFRof/426//WUBuLC8G0cbAyCWwWPWvmzl+LbPGEAe//frv6ILIkB1eNGERCwZk0nFs1NIVFPaTEnJryp5NLkD0TqtNz70eVyvK4OSkq1UnJ//T6TfUH1uwkj/QZrB0NHvJrJKjeL3v6MsCeUnimnVDm2B4iWkhNY28GTWfnaZjCM5dNOwWcJSiNpqXueO/w+Ju1Oi1YGxQOQPtgDcOAz1P1u+7/eWbO+Qs65eF2pH9muJ5U17jhNItEd3EK17m+NdX+emXo1dfffHV6MtXpy9Gy5d5OnqR/u30ZX56ijmexkk2NwGrpnF8h+mNLOolnAXA2f4BNPc0DI6rbY4pAd6iDK2R61IMEUDu6y7spay9g6POjT0nG602xyIR3FiihC/Gf2HluBOVGNK38VYAeX/Zjhu1N4CgaQ2esISSyuVws9x2a82ffXFvQt/TnZ9UCmWc7WxYsmJjvxL9xn6diILb/vRKbLdLdPTBqt2Ojz/XZLlFXyfiFq2Mw8/V9S5pM4m7dyYdX7QT1yO4H7VWHEN/z39Q35DGBz8chFLG8/su2TYEZ5H5aM48OorB3tq9mAVUH6XtD0QX7y65LSyb3xXKMD8Ii2tOOFzHbcJUEUn+4YHPtkKhXtW4YtrIk//+Cz3DYA4=",sidebar_class_name:"post api-method",info_path:"api-docs/reference/hackihub-client-api",custom_edit_url:null},b=void 0,v={},W=[];function A(e){const t={code:"code",p:"p",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Send an invitation email to a new team member"}),"\n",(0,a.jsx)(d(),{method:"post",path:"/invitations",context:"endpoint"}),"\n",(0,a.jsxs)(t.p,{children:["Creates an invitation record and sends a welcome email with an accept link. Automatically detects whether the invitee already has an account and sends the appropriate accept URL. Required permission: ",(0,a.jsx)(t.code,{children:"invitations:create"})]}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(l(),{...n(79895)}),"\n",(0,a.jsx)(c(),{...n(77789)}),"\n",(0,a.jsx)(m(),{...n(68659)})]})}function g(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(A,{...e})}):A(e)}},79895(e){e.exports=JSON.parse('{"parameters":[{"name":"x-tenant-id","in":"header","description":"Tenant ID","required":true,"schema":{"type":"string"}}]}')},77789(e){e.exports=JSON.parse('{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","default":"engineer"},"roleId":{"type":"string","format":"uuid"}},"required":["email"],"title":"CreateInvitationDto"}}}}}')},68659(e){e.exports=JSON.parse('{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"tenantId":{"type":"string","format":"uuid"},"roleId":{"type":"string","format":"uuid"},"invitedBy":{"type":"string","format":"uuid"},"invitedAt":{"type":"","x-nestjs_zod-empty-type":true},"status":{"type":"string","enum":["pending","accepted","rejected"],"default":"pending"},"statusChangedAt":{"nullable":true,"type":"","x-nestjs_zod-empty-type":true},"statusChangedBy":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"","x-nestjs_zod-empty-type":true},"updatedAt":{"nullable":true,"type":"","x-nestjs_zod-empty-type":true},"deletedAt":{"nullable":true,"type":"","x-nestjs_zod-empty-type":true},"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid","nullable":true},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"isSuperAdmin":{"type":"boolean"},"updatedAt":{"nullable":true},"deletedAt":{"nullable":true}},"required":["id","tenantId","slug","description","isSuperAdmin","createdAt","updatedAt","deletedAt"],"nullable":true,"x-nestjs_zod-self-required":false},"roleName":{"type":"string","nullable":true},"roleSlug":{"type":"string","nullable":true}},"required":["id","email","tenantId","roleId","invitedBy","invitedAt","statusChangedAt","statusChangedBy","createdAt","updatedAt","deletedAt"],"title":"ResponseInvitationDto"}}}}}}')}}]);