Skip to main content
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 '
{
  "apiKey": "up_admin_************"
}
'
{
  "status": "<string>",
  "data": {
    "projectOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>"
  }
}

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-organization Request body

​
name
string
required
Minimum string length: 1
​
projectId
string<uuid>
required
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})$
​
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})$
​
properties
object
​
externalId
string

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

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required