POST /v1/teams/{teamId}/members
Invite a user to join the team specified in the URL. The authenticated user needs to be an OWNER
in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority.
Servers
- https://api.vercel.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
email |
String | No |
The email address of the user to invite |
uid |
String | No |
The id of the user to invite |
projects[] |
Array | No | |
projects[].projectId |
String | Yes |
The ID of the project. |
projects[].role |
String | Yes |
Sets the project roles for the invited user Possible values:
|
role |
String | No |
The role of the user to invite Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.