Add Recipient
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients"
payload = {
"email": "<string>",
"firstName": "<string>",
"lastName": "<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({email: '<string>', firstName: '<string>', lastName: '<string>'})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients', 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}/projects/{projectId}/client-presentations/{presentationId}/recipients",
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([
'email' => '<string>',
'firstName' => '<string>',
'lastName' => '<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}/projects/{projectId}/client-presentations/{presentationId}/recipients"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<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}/projects/{projectId}/client-presentations/{presentationId}/recipients")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients")
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 \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"fiType": "OFCI",
"depositPct": 123,
"outcome": "awaiting",
"sections": [
{}
],
"unresolvedAlternativeSlotIds": [
"<string>"
],
"rework": [
{}
],
"message": "<string>",
"slotIds": [
"<string>"
],
"draftItems": [
{
"slotId": "<string>",
"refNumber": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"manufacturer": "<string>",
"area": "<string>",
"quantity": "<string>",
"finish": "<string>",
"dimensions": "<string>",
"alternativesCount": 123,
"alternatives": [
{
"id": "<string>",
"name": "<string>"
}
],
"extraQuantity": "<string>",
"quantityUnit": "<string>",
"purchasingUnit": "packages",
"unitsPerPackage": "<string>",
"areaQuantities": [
{
"areaId": "<string>",
"quantity": "<string>",
"roomCount": 123,
"roomsDiffer": true,
"areaTotal": "<string>"
}
],
"unitPrice": "<string>",
"sourceItemId": "<string>",
"displayFields": {},
"currency": "<string>",
"subtotal": "<string>",
"taxRate": "<string>",
"taxLabel": "<string>",
"taxAmount": "<string>",
"total": "<string>",
"previousUnitPrice": "<string>",
"priceDelta": "<string>"
}
],
"expiresAt": "<string>",
"hasUnsharedChanges": true,
"versions": [
{
"n": 123,
"sharedAt": "<string>",
"sharedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"changeSummary": "<string>"
}
],
"parties": {
"client": {
"name": "<string>",
"address": "<string>"
},
"studio": {
"name": "<string>",
"legalName": "<string>",
"address": "<string>",
"logoUrl": "<string>"
}
},
"versionLabel": "<string>",
"projectNumber": "<string>",
"archivedAt": "<string>",
"source": {},
"followUps": [
{
"presentationId": "<string>",
"versionN": 123
}
],
"reworkCount": 123,
"id": "<string>",
"collaborationId": "<string>",
"projectId": "<string>",
"project": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"status": "draft",
"expired": true,
"template": {
"id": "<string>",
"name": "<string>"
},
"presentation": {
"id": "<string>",
"name": "<string>",
"slideCount": 123,
"archived": true
},
"currentVersion": {
"n": 123,
"sharedAt": "<string>",
"sharedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
},
"versionCount": 123,
"recipients": [
{
"userId": "<string>",
"email": "<string>",
"name": "<string>",
"reviewStatus": "in_progress",
"lastViewedAt": "<string>",
"submittedAt": "<string>",
"accessRevoked": true
}
],
"outcomes": {
"accepted": 123,
"refused": 123,
"alternative": 123,
"pending": 123,
"total": 123
},
"commentCount": 123,
"lastActivity": {
"type": "created",
"actorName": "<string>",
"at": "<string>"
},
"lastActivityAt": "<string>",
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"createdAt": "<string>",
"draftRecipients": [
{
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"recipientChangesPending": true,
"requiresNewVersion": true,
"revision": 123,
"signing": {
"status": "<string>",
"required": [
{
"role": "<string>",
"userId": "<string>",
"signed": true
}
],
"countersignature": true,
"countersigned": true
},
"reviewTemplate": {
"id": "<string>",
"name": "<string>"
},
"signerBindings": [
{}
]
}Client Presentations
Add Recipient
POST
/
v1
/
workspaces
/
{workspaceId}
/
projects
/
{projectId}
/
client-presentations
/
{presentationId}
/
recipients
Add Recipient
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients"
payload = {
"email": "<string>",
"firstName": "<string>",
"lastName": "<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({email: '<string>', firstName: '<string>', lastName: '<string>'})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients', 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}/projects/{projectId}/client-presentations/{presentationId}/recipients",
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([
'email' => '<string>',
'firstName' => '<string>',
'lastName' => '<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}/projects/{projectId}/client-presentations/{presentationId}/recipients"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<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}/projects/{projectId}/client-presentations/{presentationId}/recipients")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/client-presentations/{presentationId}/recipients")
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 \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"fiType": "OFCI",
"depositPct": 123,
"outcome": "awaiting",
"sections": [
{}
],
"unresolvedAlternativeSlotIds": [
"<string>"
],
"rework": [
{}
],
"message": "<string>",
"slotIds": [
"<string>"
],
"draftItems": [
{
"slotId": "<string>",
"refNumber": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"manufacturer": "<string>",
"area": "<string>",
"quantity": "<string>",
"finish": "<string>",
"dimensions": "<string>",
"alternativesCount": 123,
"alternatives": [
{
"id": "<string>",
"name": "<string>"
}
],
"extraQuantity": "<string>",
"quantityUnit": "<string>",
"purchasingUnit": "packages",
"unitsPerPackage": "<string>",
"areaQuantities": [
{
"areaId": "<string>",
"quantity": "<string>",
"roomCount": 123,
"roomsDiffer": true,
"areaTotal": "<string>"
}
],
"unitPrice": "<string>",
"sourceItemId": "<string>",
"displayFields": {},
"currency": "<string>",
"subtotal": "<string>",
"taxRate": "<string>",
"taxLabel": "<string>",
"taxAmount": "<string>",
"total": "<string>",
"previousUnitPrice": "<string>",
"priceDelta": "<string>"
}
],
"expiresAt": "<string>",
"hasUnsharedChanges": true,
"versions": [
{
"n": 123,
"sharedAt": "<string>",
"sharedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"changeSummary": "<string>"
}
],
"parties": {
"client": {
"name": "<string>",
"address": "<string>"
},
"studio": {
"name": "<string>",
"legalName": "<string>",
"address": "<string>",
"logoUrl": "<string>"
}
},
"versionLabel": "<string>",
"projectNumber": "<string>",
"archivedAt": "<string>",
"source": {},
"followUps": [
{
"presentationId": "<string>",
"versionN": 123
}
],
"reworkCount": 123,
"id": "<string>",
"collaborationId": "<string>",
"projectId": "<string>",
"project": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"status": "draft",
"expired": true,
"template": {
"id": "<string>",
"name": "<string>"
},
"presentation": {
"id": "<string>",
"name": "<string>",
"slideCount": 123,
"archived": true
},
"currentVersion": {
"n": 123,
"sharedAt": "<string>",
"sharedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
},
"versionCount": 123,
"recipients": [
{
"userId": "<string>",
"email": "<string>",
"name": "<string>",
"reviewStatus": "in_progress",
"lastViewedAt": "<string>",
"submittedAt": "<string>",
"accessRevoked": true
}
],
"outcomes": {
"accepted": 123,
"refused": 123,
"alternative": 123,
"pending": 123,
"total": 123
},
"commentCount": 123,
"lastActivity": {
"type": "created",
"actorName": "<string>",
"at": "<string>"
},
"lastActivityAt": "<string>",
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"createdAt": "<string>",
"draftRecipients": [
{
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"recipientChangesPending": true,
"requiresNewVersion": true,
"revision": 123,
"signing": {
"status": "<string>",
"required": [
{
"role": "<string>",
"userId": "<string>",
"signed": true
}
],
"countersignature": true,
"countersigned": true
},
"reviewTemplate": {
"id": "<string>",
"name": "<string>"
},
"signerBindings": [
{}
]
}Body
application/json
Response
200 - application/json
⌘I