Skip to main content
PUT
Update a project organization

Authorizations

apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Path Parameters

projectId
string<uuid>
required

PUT /v1/api/projects/:projectId/organizations/:projectOrganizationId Parameter

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})$
projectOrganizationId
string<uuid>
required

PUT /v1/api/projects/:projectId/organizations/:projectOrganizationId Parameter

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})$

Body

application/json

PUT /v1/api/projects/:projectId/organizations/:projectOrganizationId Request body

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>

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"

name
string

The organization's display name.

Minimum string length: 1
properties
object

Key/value metadata for the organization, used to scope and secure data for its users. Replaces the stored set.

externalId
string | null

Your own identifier for this organization (e.g. your internal company UUID), as register-organization's externalId. embed-token and register-user find the organization by it. Unique within the project. null removes it.

Minimum string length: 1
Example:

"acme-internal-uuid-1234"

Response

PUT /v1/api/projects/:projectId/organizations/:projectOrganizationId Positive response

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