Skip to main content
POST
Create a project user role. A role grants editing…

Authorizations

apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Path Parameters

projectId
string<uuid>
required

The project the role 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})$

Body

application/json

POST /v1/api/projects/:projectId/user-roles Request body

name
string
required

The role's name, unique in the project.

Minimum string length: 1
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"

permissions
object

A project user role's permissions. A role grants editing only through one of addChart, addFilter, createChart, editCharts, removeChart, addDashboard or canDuplicateDashboard set to true, and never while readOnly is on. Any other role, {} included, is view-only, and so is a project user with no role. An edit never changes the shared dashboard: it is saved to the user's own copy.

Response

POST /v1/api/projects/:projectId/user-roles Positive response

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