curl --request POST \
--url http://localhost:3000/api/v1/portal/{slug}/requests \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"note": "<string>",
"page": "<string>",
"section": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/portal/{slug}/requests"
payload = {
"email": "[email protected]",
"name": "<string>",
"note": "<string>",
"page": "<string>",
"section": "<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: '[email protected]',
name: '<string>',
note: '<string>',
page: '<string>',
section: '<string>'
})
};
fetch('http://localhost:3000/api/v1/portal/{slug}/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/portal/{slug}/requests",
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' => '[email protected]',
'name' => '<string>',
'note' => '<string>',
'page' => '<string>',
'section' => '<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 := "http://localhost:3000/api/v1/portal/{slug}/requests"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<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("http://localhost:3000/api/v1/portal/{slug}/requests")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/portal/{slug}/requests")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"received": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Ask for access to a portal, or ask its brand team
Access (kind access, the default) is for a password or members portal. The workspace’s admins hear about it. It answers the same whoever asks, and asking twice while one waits is one request. A request section’s ask (kind asset, review or question) works on any portal, says the page and section it came from, and needs what reading that page needs (X-Portal-Password or X-Portal-Key, or a member’s session), else 401. The page must be one the visitor can read and section a request section on it; access takes neither.
No key needed.
curl --request POST \
--url http://localhost:3000/api/v1/portal/{slug}/requests \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"note": "<string>",
"page": "<string>",
"section": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/portal/{slug}/requests"
payload = {
"email": "[email protected]",
"name": "<string>",
"note": "<string>",
"page": "<string>",
"section": "<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: '[email protected]',
name: '<string>',
note: '<string>',
page: '<string>',
section: '<string>'
})
};
fetch('http://localhost:3000/api/v1/portal/{slug}/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/portal/{slug}/requests",
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' => '[email protected]',
'name' => '<string>',
'note' => '<string>',
'page' => '<string>',
'section' => '<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 := "http://localhost:3000/api/v1/portal/{slug}/requests"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<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("http://localhost:3000/api/v1/portal/{slug}/requests")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/portal/{slug}/requests")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"page\": \"<string>\",\n \"section\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"received": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Path Parameters
The portal's address
Body
320^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$120Who you are and what you need it for
2000access when left out; a request section asks for an asset, a review or an answer
access, asset, review, question The page a request section sits on
60^[a-z0-9]+(-[a-z0-9]+)*$The request section, by id
^[a-z0-9_-]{1,40}$Response
Received
Show child attributes
Show child attributes