Add Users
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{
"email": "jsmith@example.com",
"contactPersonId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"companyTags": [
"<string>"
]
}
]
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users"
payload = { "users": [
{
"email": "jsmith@example.com",
"contactPersonId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"companyTags": ["<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({
users: [
{
email: 'jsmith@example.com',
contactPersonId: '<string>',
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
companyTags: ['<string>']
}
]
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users', 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}/collaborations/{collabId}/users",
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([
'users' => [
[
'email' => 'jsmith@example.com',
'contactPersonId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'companyName' => '<string>',
'companyTags' => [
'<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}/collaborations/{collabId}/users"
payload := strings.NewReader("{\n \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\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}/collaborations/{collabId}/users")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users")
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 \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"logicType": "<string>",
"createdById": "<string>",
"sharingData": {},
"status": "draft",
"inviteeCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"invitees": [
{
"id": "<string>",
"userId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"status": "pending",
"acceptedAt": "2023-11-07T05:31:56Z"
}
]
}Collaborations
Add Users
POST
/
v1
/
workspaces
/
{workspaceId}
/
collaborations
/
{collabId}
/
users
Add Users
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{
"email": "jsmith@example.com",
"contactPersonId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"companyTags": [
"<string>"
]
}
]
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users"
payload = { "users": [
{
"email": "jsmith@example.com",
"contactPersonId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"companyTags": ["<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({
users: [
{
email: 'jsmith@example.com',
contactPersonId: '<string>',
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
companyTags: ['<string>']
}
]
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users', 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}/collaborations/{collabId}/users",
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([
'users' => [
[
'email' => 'jsmith@example.com',
'contactPersonId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'companyName' => '<string>',
'companyTags' => [
'<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}/collaborations/{collabId}/users"
payload := strings.NewReader("{\n \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\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}/collaborations/{collabId}/users")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collaborations/{collabId}/users")
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 \"users\": [\n {\n \"email\": \"jsmith@example.com\",\n \"contactPersonId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyTags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"logicType": "<string>",
"createdById": "<string>",
"sharingData": {},
"status": "draft",
"inviteeCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"invitees": [
{
"id": "<string>",
"userId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"status": "pending",
"acceptedAt": "2023-11-07T05:31:56Z"
}
]
}Body
application/json
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
200 - application/json
Available options:
draft, sent, archived Show child attributes
Show child attributes
⌘I