Register organization to Upsolve
curl --request POST \
--url 'https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Inc",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"properties": {
"plan": "enterprise",
"region": "us-east"
},
"externalId": "acme-internal-uuid-1234",
"apiKey": "up_embed_************",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"environment": "production"
}
'import requests
url = "https://api.upsolve.ai/v1/api/projects/register-organization?apiKey="
payload = {
"name": "Acme Inc",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"properties": {
"plan": "enterprise",
"region": "us-east"
},
"externalId": "acme-internal-uuid-1234",
"apiKey": "up_embed_************",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"environment": "production"
}
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({
name: 'Acme Inc',
projectId: '123e4567-e89b-12d3-a456-426614174000',
properties: {plan: 'enterprise', region: 'us-east'},
externalId: 'acme-internal-uuid-1234',
apiKey: 'up_embed_************',
organizationId: '123e4567-e89b-12d3-a456-426614174000',
environment: 'production'
})
};
fetch('https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=', 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.upsolve.ai/v1/api/projects/register-organization?apiKey=",
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([
'name' => 'Acme Inc',
'projectId' => '123e4567-e89b-12d3-a456-426614174000',
'properties' => [
'plan' => 'enterprise',
'region' => 'us-east'
],
'externalId' => 'acme-internal-uuid-1234',
'apiKey' => 'up_embed_************',
'organizationId' => '123e4567-e89b-12d3-a456-426614174000',
'environment' => 'production'
]),
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.upsolve.ai/v1/api/projects/register-organization?apiKey="
payload := strings.NewReader("{\n \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\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.upsolve.ai/v1/api/projects/register-organization?apiKey=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=")
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 \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"projectOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "acme-internal-uuid-1234"
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Embedding
Register Project Organization
Use this endpoint to create a new organization. This allows you to organize users and data within a project by organization.
POST
/
v1
/
api
/
projects
/
register-organization
Register organization to Upsolve
curl --request POST \
--url 'https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Inc",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"properties": {
"plan": "enterprise",
"region": "us-east"
},
"externalId": "acme-internal-uuid-1234",
"apiKey": "up_embed_************",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"environment": "production"
}
'import requests
url = "https://api.upsolve.ai/v1/api/projects/register-organization?apiKey="
payload = {
"name": "Acme Inc",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"properties": {
"plan": "enterprise",
"region": "us-east"
},
"externalId": "acme-internal-uuid-1234",
"apiKey": "up_embed_************",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"environment": "production"
}
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({
name: 'Acme Inc',
projectId: '123e4567-e89b-12d3-a456-426614174000',
properties: {plan: 'enterprise', region: 'us-east'},
externalId: 'acme-internal-uuid-1234',
apiKey: 'up_embed_************',
organizationId: '123e4567-e89b-12d3-a456-426614174000',
environment: 'production'
})
};
fetch('https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=', 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.upsolve.ai/v1/api/projects/register-organization?apiKey=",
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([
'name' => 'Acme Inc',
'projectId' => '123e4567-e89b-12d3-a456-426614174000',
'properties' => [
'plan' => 'enterprise',
'region' => 'us-east'
],
'externalId' => 'acme-internal-uuid-1234',
'apiKey' => 'up_embed_************',
'organizationId' => '123e4567-e89b-12d3-a456-426614174000',
'environment' => 'production'
]),
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.upsolve.ai/v1/api/projects/register-organization?apiKey="
payload := strings.NewReader("{\n \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\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.upsolve.ai/v1/api/projects/register-organization?apiKey=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v1/api/projects/register-organization?apiKey=")
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 \"name\": \"Acme Inc\",\n \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"properties\": {\n \"plan\": \"enterprise\",\n \"region\": \"us-east\"\n },\n \"externalId\": \"acme-internal-uuid-1234\",\n \"apiKey\": \"up_embed_************\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"environment\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"projectOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "acme-internal-uuid-1234"
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Authorizations
apiKey MUST be supplied within the request body instead of query
Body
application/json
POST /v1/api/projects/register-organization Request body
Display name for the organization. This will appear in the Upsolve Hub.
Minimum string length:
1Example:
"Acme Inc"
The ID of the project this organization belongs to.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$Example:
"123e4567-e89b-12d3-a456-426614174000"
Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.
Minimum string length:
1Example:
"up_embed_************"
Your Upsolve organization's UUID — the org that owns the API key and project. This is NOT a project organization: do not pass a value registered via /projects/register-organization, and do not pass an externalId (only projectOrganizationId accepts those). Omit it when using an org-bound API key — the org is read from the key and any value sent here is ignored. Required only for user-scoped API keys (created under Account → Developer settings) and for the Supabase JWT path, where the org is ambiguous and membership is verified against it.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$Example:
"123e4567-e89b-12d3-a456-426614174000"
Optional key/value metadata for the organization. Used to scope and secure data when its users access an Upsolve dashboard.
Show child attributes
Show child attributes
Example:
{ "plan": "enterprise", "region": "us-east" }
Optional external identifier for this project organization (e.g. your internal company UUID). When set, subsequent calls that accept projectOrganizationId will resolve this value to the underlying Upsolve UUID.
Minimum string length:
1Example:
"acme-internal-uuid-1234"
The environment the organization and its users belong to: production (the default) or one the project created, such as staging.
Example:
"production"
Was this page helpful?