Create Invitations
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations \
--header 'Content-Type: application/json' \
--data '
{
"emails": [
"<string>"
],
"inviteeName": "<string>",
"memberTags": [
"<string>"
],
"approvedSeatPrices": [
{
"licenseId": "<string>",
"seatPriceUsd": "<string>"
}
],
"licenseIds": [
"<string>"
],
"teamIds": [
"<string>"
],
"seatLevels": [
{
"licenseId": "<string>",
"viewOnlyFeatureKeys": [],
"noAccessFeatureKeys": []
}
],
"allProjects": true,
"projectRegionKeys": [
"<string>"
],
"projectLocationIds": [
"<string>"
],
"projectIds": [
"<string>"
],
"viewOnlyProjectIds": [
"<string>"
],
"workspaceAccess": {
"createProjects": true
},
"roleId": "<string>"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations"
payload = {
"emails": ["<string>"],
"inviteeName": "<string>",
"memberTags": ["<string>"],
"approvedSeatPrices": [
{
"licenseId": "<string>",
"seatPriceUsd": "<string>"
}
],
"licenseIds": ["<string>"],
"teamIds": ["<string>"],
"seatLevels": [
{
"licenseId": "<string>",
"viewOnlyFeatureKeys": [],
"noAccessFeatureKeys": []
}
],
"allProjects": True,
"projectRegionKeys": ["<string>"],
"projectLocationIds": ["<string>"],
"projectIds": ["<string>"],
"viewOnlyProjectIds": ["<string>"],
"workspaceAccess": { "createProjects": True },
"roleId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
emails: ['<string>'],
inviteeName: '<string>',
memberTags: ['<string>'],
approvedSeatPrices: [{licenseId: '<string>', seatPriceUsd: '<string>'}],
licenseIds: ['<string>'],
teamIds: ['<string>'],
seatLevels: [{licenseId: '<string>', viewOnlyFeatureKeys: [], noAccessFeatureKeys: []}],
allProjects: true,
projectRegionKeys: ['<string>'],
projectLocationIds: ['<string>'],
projectIds: ['<string>'],
viewOnlyProjectIds: ['<string>'],
workspaceAccess: {createProjects: true},
roleId: '<string>'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'emails' => [
'<string>'
],
'inviteeName' => '<string>',
'memberTags' => [
'<string>'
],
'approvedSeatPrices' => [
[
'licenseId' => '<string>',
'seatPriceUsd' => '<string>'
]
],
'licenseIds' => [
'<string>'
],
'teamIds' => [
'<string>'
],
'seatLevels' => [
[
'licenseId' => '<string>',
'viewOnlyFeatureKeys' => [
],
'noAccessFeatureKeys' => [
]
]
],
'allProjects' => true,
'projectRegionKeys' => [
'<string>'
],
'projectLocationIds' => [
'<string>'
],
'projectIds' => [
'<string>'
],
'viewOnlyProjectIds' => [
'<string>'
],
'workspaceAccess' => [
'createProjects' => true
],
'roleId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations"
payload := strings.NewReader("{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations")
.header("Content-Type", "application/json")
.body("{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"email": "<string>",
"success": true,
"error": "<string>",
"invitation": {
"isOwnerActivation": true,
"id": "<string>",
"workspaceId": "<string>",
"email": "<string>",
"invitedById": "<string>",
"invitedByUserId": "<string>",
"invitedByAdminId": "<string>",
"governanceLevel": "admin",
"memberTags": [
"<string>"
],
"inviteeName": "<string>",
"status": "revoked",
"expiresAt": "<string>",
"acceptedAt": "<string>",
"createdAt": "<string>",
"offeredLicenses": [
{
"licenseId": "<string>",
"packageKey": "<string>",
"displayName": "<string>"
}
],
"teams": [
{
"id": "<string>",
"name": "<string>"
}
],
"projectedSeats": [
{
"licenseId": "<string>",
"packageKey": "<string>",
"displayName": "<string>"
}
]
}
}
]
}Invitations
Create Invitations
POST
/
v1
/
workspaces
/
{workspaceId}
/
invitations
Create Invitations
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations \
--header 'Content-Type: application/json' \
--data '
{
"emails": [
"<string>"
],
"inviteeName": "<string>",
"memberTags": [
"<string>"
],
"approvedSeatPrices": [
{
"licenseId": "<string>",
"seatPriceUsd": "<string>"
}
],
"licenseIds": [
"<string>"
],
"teamIds": [
"<string>"
],
"seatLevels": [
{
"licenseId": "<string>",
"viewOnlyFeatureKeys": [],
"noAccessFeatureKeys": []
}
],
"allProjects": true,
"projectRegionKeys": [
"<string>"
],
"projectLocationIds": [
"<string>"
],
"projectIds": [
"<string>"
],
"viewOnlyProjectIds": [
"<string>"
],
"workspaceAccess": {
"createProjects": true
},
"roleId": "<string>"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations"
payload = {
"emails": ["<string>"],
"inviteeName": "<string>",
"memberTags": ["<string>"],
"approvedSeatPrices": [
{
"licenseId": "<string>",
"seatPriceUsd": "<string>"
}
],
"licenseIds": ["<string>"],
"teamIds": ["<string>"],
"seatLevels": [
{
"licenseId": "<string>",
"viewOnlyFeatureKeys": [],
"noAccessFeatureKeys": []
}
],
"allProjects": True,
"projectRegionKeys": ["<string>"],
"projectLocationIds": ["<string>"],
"projectIds": ["<string>"],
"viewOnlyProjectIds": ["<string>"],
"workspaceAccess": { "createProjects": True },
"roleId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
emails: ['<string>'],
inviteeName: '<string>',
memberTags: ['<string>'],
approvedSeatPrices: [{licenseId: '<string>', seatPriceUsd: '<string>'}],
licenseIds: ['<string>'],
teamIds: ['<string>'],
seatLevels: [{licenseId: '<string>', viewOnlyFeatureKeys: [], noAccessFeatureKeys: []}],
allProjects: true,
projectRegionKeys: ['<string>'],
projectLocationIds: ['<string>'],
projectIds: ['<string>'],
viewOnlyProjectIds: ['<string>'],
workspaceAccess: {createProjects: true},
roleId: '<string>'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'emails' => [
'<string>'
],
'inviteeName' => '<string>',
'memberTags' => [
'<string>'
],
'approvedSeatPrices' => [
[
'licenseId' => '<string>',
'seatPriceUsd' => '<string>'
]
],
'licenseIds' => [
'<string>'
],
'teamIds' => [
'<string>'
],
'seatLevels' => [
[
'licenseId' => '<string>',
'viewOnlyFeatureKeys' => [
],
'noAccessFeatureKeys' => [
]
]
],
'allProjects' => true,
'projectRegionKeys' => [
'<string>'
],
'projectLocationIds' => [
'<string>'
],
'projectIds' => [
'<string>'
],
'viewOnlyProjectIds' => [
'<string>'
],
'workspaceAccess' => [
'createProjects' => true
],
'roleId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations"
payload := strings.NewReader("{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations")
.header("Content-Type", "application/json")
.body("{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"emails\": [\n \"<string>\"\n ],\n \"inviteeName\": \"<string>\",\n \"memberTags\": [\n \"<string>\"\n ],\n \"approvedSeatPrices\": [\n {\n \"licenseId\": \"<string>\",\n \"seatPriceUsd\": \"<string>\"\n }\n ],\n \"licenseIds\": [\n \"<string>\"\n ],\n \"teamIds\": [\n \"<string>\"\n ],\n \"seatLevels\": [\n {\n \"licenseId\": \"<string>\",\n \"viewOnlyFeatureKeys\": [],\n \"noAccessFeatureKeys\": []\n }\n ],\n \"allProjects\": true,\n \"projectRegionKeys\": [\n \"<string>\"\n ],\n \"projectLocationIds\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"viewOnlyProjectIds\": [\n \"<string>\"\n ],\n \"workspaceAccess\": {\n \"createProjects\": true\n },\n \"roleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"email": "<string>",
"success": true,
"error": "<string>",
"invitation": {
"isOwnerActivation": true,
"id": "<string>",
"workspaceId": "<string>",
"email": "<string>",
"invitedById": "<string>",
"invitedByUserId": "<string>",
"invitedByAdminId": "<string>",
"governanceLevel": "admin",
"memberTags": [
"<string>"
],
"inviteeName": "<string>",
"status": "revoked",
"expiresAt": "<string>",
"acceptedAt": "<string>",
"createdAt": "<string>",
"offeredLicenses": [
{
"licenseId": "<string>",
"packageKey": "<string>",
"displayName": "<string>"
}
],
"teams": [
{
"id": "<string>",
"name": "<string>"
}
],
"projectedSeats": [
{
"licenseId": "<string>",
"packageKey": "<string>",
"displayName": "<string>"
}
]
}
}
]
}Body
application/json
⌘I