यूज़र को इनवाइट करें

दिए गए email पर आपके workspace में शामिल होने का email invitation भेजता है। यदि user का account नहीं है, तो उन्हें एक बनाने के लिए कहा जाएगा। user के इस invite को स्वीकार करने पर, आपकी एक seat का इस्तेमाल करके उन्हें आपके workspace और subscription में user के रूप में जोड़ा जाएगा। इस endpoint को केवल WORKSPACE_MEMBERS_INVITE permission वाले workspace members ही call कर सकते हैं। user पहले से workspace में होने पर 400 error लौटाया जाएगा।

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
emailstringRequired

ग्राहक का ईमेल

seat_typeenum or nullOptional

यूज़र का सीट प्रकार

Allowed values:
group_idslist of strings or nullOptional

यूज़र की ग्रुप IDs

usage_limitinteger or nullOptional>=0

आमंत्रित व्यक्ति के लिए मासिक क्रेडिट उपयोग सीमा। कस्टम सीमा न रखने के लिए छोड़ दें या null पर सेट करें।

workspace_permissionstring or nullOptionalDeprecated

यूज़र की वर्कस्पेस अनुमति। यह डिप्रिकेटेड है, इसकी जगह seat_type इस्तेमाल करें।

Response

सफल रिस्पॉन्स

statusstring

वर्कस्पेस इनवाइट अनुरोध का स्टेटस। अनुरोध सफल होने पर स्टेटस ‘ok’ होगा। अन्यथा, स्टेटस 500 के साथ एक एरर मैसेज लौटाया जाएगा।

Errors

422
Unprocessable Entity Error