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 '
{
  "name": "Acme Inc",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "properties": {
    "plan": "enterprise",
    "region": "us-east"
  },
  "externalId": "acme-internal-uuid-1234",
  "apiKey": "up_embed_************"
}
'
{
  "status": "<string>",
  "data": {
    "projectOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>"
  }
}

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

Display name for the organization. This will appear in the Upsolve Hub.

Minimum string length: 1
Example:

"Acme Inc"

​
projectId
string<uuid>
required

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"

​
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})$
​
properties
object

Optional key/value metadata for the organization. Used to scope and secure data when its users access an Upsolve dashboard.

Example:
{ "plan": "enterprise", "region": "us-east" }
​
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
Example:

"acme-internal-uuid-1234"

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "projectOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "acme-internal-uuid-1234"
}