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_admin_************",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "status": "<string>",
  "data": {
    "message": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.upsolve.ai/llms.txt

Use this file to discover all available pages before exploring further.

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 in the Deploy tab of the Upsolve Hub.

Minimum string length: 1
Example:

"up_admin_************"

​
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"
}