POST /api/workspaces/invitations/workspace/{workspace_id}/
Creates a new workspace invitations for an email address if the authorized user has admin rights to the related workspace. An email containing a sign up link will be send to the user.
Servers
- /
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_id |
Integer | Yes |
Creates a workspace invitation to the workspace related to the provided value. |
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 | Yes |
The email address of the user that the invitation is meant for. Only a user with that email address can accept it. |
message |
String | No |
An optional message that the invitor can provide. This will be visible to the receiver of the invitation. |
permissions |
String | No |
The permissions that the user is going to get within the workspace after accepting the invitation. |
base_url |
String | Yes |
The base URL where the user can publicly accept his invitation.The accept token is going to be appended to the base_url (base_url '/token'). |
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.