Home
DocumentationTutorialsTry Cloud

Invite

The "Invite" section houses endpoints related to inviting team members, removing team members, accepting invitations to join a team, and canceling team invitations.

Invite a member

POST {{BASE_URL}}/api/teams/{id}/invite

Invite a user to a specific team.

Path Parameters

NameTypeDescription

id*

String

Team ID

Headers

NameTypeDescription

Authorization*

String

Bearer Token

Request Body

NameTypeDescription

emails*

[String]

["email@exmaple.com"]

{"status":"ok"}

Accept invitation

POST {{BASE_URL}}/api/invite/{id}

Accept an invitation to join the team.

Path Parameters

NameTypeDescription

id*

String

Invite ID

Headers

NameTypeDescription

Authorization*

String

Bearer Token

Request Body

NameTypeDescription

email*

String

password*

String

{
    "userToken": "userToken",
    "vaultToken": "teamToken"
}

Invitation list

GET {{BASE_URL}}/api/teams/{id}/invite

Get a list of invitations to the team.

Path Parameters

NameTypeDescription

id*

String

Team ID

Headers

NameTypeDescription

Authorization*

String

Bearer Token

[{"_id":"6548fd8dff600e06af2a95e2","email":"test@test.com"}]

Get invitation

GET {{BASE_URL}}/api/invite/{id}

Get team invitation information by unique id.

Path Parameters

NameTypeDescription

id*

String

Invite ID

Headers

NameTypeDescription

Authorization*

String

Bearer Token

{"_id":"6548fd8dff600e06af2a95e2","email":"test@test.com"}

Cancel invitation

DELETE {{BASE_URL}}/api/teams/{id}/invite/{inviteId}

Cancel the invitation to the team.

Path Parameters

NameTypeDescription

id*

String

Team ID

inviteId

String

Invite id

Headers

NameTypeDescription

Authorization*

String

Bearer Token

true

Last updated