Skip to main content

Create team invite

POST /api/v1/Teams/invite/create

Description​

This endpoint is used to create an invite for a team.

Tags: Teams

URL:
/api/v{version}/Teams/invite/create

ApiKey:
No API key required

Content-Type:
application/json, text/json, application/*+json

Path Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)

Request Body:
CreateRequest

Response:
Success, returns a string response.

Error Codes:
400: Bad Request
404: Not Found

/api/v1/Teams/invite/create

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "email": `<string>`,
  "role": 3
}

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Teams/invite/create \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!