Skip to main content
POST
/
v1
/
api
/
projects
/
register-user
Register project user to Upsolve
curl --request POST \
  --url 'https://api.upsolve.ai/v1/api/projects/register-user?apiKey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Google Inc",
  "properties": {
    "company_id": "company-google",
    "company_class": "tech"
  },
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "userRoleId": "123e4567-e89b-12d3-a456-426614174000",
  "projectOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
  "apiKey": "up_embed_************",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}
'
import requests

url = "https://api.upsolve.ai/v1/api/projects/register-user?apiKey="

payload = {
    "name": "Google Inc",
    "properties": {
        "company_id": "company-google",
        "company_class": "tech"
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "userRoleId": "123e4567-e89b-12d3-a456-426614174000",
    "projectOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "apiKey": "up_embed_************",
    "userId": "123e4567-e89b-12d3-a456-426614174000"
}
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: 'Google Inc',
    properties: {company_id: 'company-google', company_class: 'tech'},
    projectId: '123e4567-e89b-12d3-a456-426614174000',
    userRoleId: '123e4567-e89b-12d3-a456-426614174000',
    projectOrganizationId: '123e4567-e89b-12d3-a456-426614174000',
    apiKey: 'up_embed_************',
    userId: '123e4567-e89b-12d3-a456-426614174000'
  })
};

fetch('https://api.upsolve.ai/v1/api/projects/register-user?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-user?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' => 'Google Inc',
    'properties' => [
        'company_id' => 'company-google',
        'company_class' => 'tech'
    ],
    'projectId' => '123e4567-e89b-12d3-a456-426614174000',
    'userRoleId' => '123e4567-e89b-12d3-a456-426614174000',
    'projectOrganizationId' => '123e4567-e89b-12d3-a456-426614174000',
    'apiKey' => 'up_embed_************',
    'userId' => '123e4567-e89b-12d3-a456-426614174000'
  ]),
  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-user?apiKey="

	payload := strings.NewReader("{\n  \"name\": \"Google Inc\",\n  \"properties\": {\n    \"company_id\": \"company-google\",\n    \"company_class\": \"tech\"\n  },\n  \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"userRoleId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"projectOrganizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"apiKey\": \"up_embed_************\",\n  \"userId\": \"123e4567-e89b-12d3-a456-426614174000\"\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-user?apiKey=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Google Inc\",\n  \"properties\": {\n    \"company_id\": \"company-google\",\n    \"company_class\": \"tech\"\n  },\n  \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"userRoleId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"projectOrganizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"apiKey\": \"up_embed_************\",\n  \"userId\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.upsolve.ai/v1/api/projects/register-user?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\": \"Google Inc\",\n  \"properties\": {\n    \"company_id\": \"company-google\",\n    \"company_class\": \"tech\"\n  },\n  \"projectId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"userRoleId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"projectOrganizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"apiKey\": \"up_embed_************\",\n  \"userId\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "<string>",
  "data": {
    "message": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "status": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": {}
  }
}

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json

POST /v1/api/projects/register-user Request body

​
name
string
required

Display name for this user. This will appear in the Upsolve Hub.

Example:

"Google Inc"

​
properties
object
required

Properties of a user

​
projectId
string<uuid>
required

The ID of the project

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"

​
userRoleId
string<uuid>
required

The ID of the user role

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"

​
projectOrganizationId
string
required

Identifier of the project organization the user belongs to. Accepts either the Upsolve-issued UUID or the project organization's externalId (set at /register-organization time).

Minimum string length: 1
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
apiKey
string

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: 1
Example:

"up_embed_************"

​
organizationId
string<uuid>
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})$
​
userId
string<uuid>

Optional ID for the project user. If provided, this value is used as the project_users.id; otherwise the database generates one.

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"

Response

POST /v1/api/projects/register-user Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "message": "User Google Inc registered.",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}