roleElevation

Request role elevation

User requests to upgrade to a specific role. May require payment, KYC, or admin approval based on role configuration.

POST/api/projects/{projectId}/role-elevation/request

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID.

Request Body

Role slug to request elevation to (e.g. a higher-privilege role you configured).

json

{
  "roleSlug": "seller"
}
{
  "roleSlug": "seller"
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.roleElevation.request({
  projectId: "proj_Jd5aIpCm82qI",
  roleSlug: "heartfelt-analogy-i9gq"
});
const result = await client.roleElevation.request({
  projectId: "proj_Jd5aIpCm82qI",
  roleSlug: "heartfelt-analogy-i9gq"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

Request Body (JSON)

No Request Yet

Send a request to see the full inspector

Responses

200Role elevation request created or auto-approved

json

{
  "message": "Request submitted",
  "requestId": "req_abc123",
  "workflow": "pending_admin_approval",
  "status": "pending"
}
{
  "message": "Request submitted",
  "requestId": "req_abc123",
  "workflow": "pending_admin_approval",
  "status": "pending"
}

400Invalid request or already has role

401Authentication required or invalid token.

403Cannot request role with higher hierarchy

404Role not found (exact backend message).

Errors

Code	Meaning
`400`	Invalid request or already has role
`401`	Authentication required or invalid token.
`403`	Cannot request role with higher hierarchy
`404`	Role not found (exact backend message).

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub