Workspace
Send a public workspace signup code
Starts or resumes the email-code signup flow for the trusted request host. Admission must be enabled. Returns a generic acknowledgement and masked mailbox without disclosing whether an account exists. Resending replaces the old code; defaults are15 minutes and5 attempts.
POST
/
workspace-onboarding
/
self-serve
/
request-code
Send a public workspace signup code
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code \
--header 'Content-Type: application/json' \
--data '
{
"email": "jane@example.org"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code"
payload = { "email": "jane@example.org" }
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: 'jane@example.org'})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code', 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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code",
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' => 'jane@example.org'
]),
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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code"
payload := strings.NewReader("{\n \"email\": \"jane@example.org\"\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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jane@example.org\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code")
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\": \"jane@example.org\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email_hint": "j***@example.org"
},
"message": "If workspace setup is available, a verification code has been sent."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}Body
application/json
Validated request fields for this operation.
Mailbox that will own the new workspace.
Maximum string length:
255Example:
"jane@example.org"
⌘I
Send a public workspace signup code
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code \
--header 'Content-Type: application/json' \
--data '
{
"email": "jane@example.org"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code"
payload = { "email": "jane@example.org" }
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: 'jane@example.org'})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code', 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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code",
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' => 'jane@example.org'
]),
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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code"
payload := strings.NewReader("{\n \"email\": \"jane@example.org\"\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://api.gratona.com/v1/workspace-onboarding/self-serve/request-code")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jane@example.org\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/self-serve/request-code")
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\": \"jane@example.org\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email_hint": "j***@example.org"
},
"message": "If workspace setup is available, a verification code has been sent."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}