> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a custom role > Edit a custom role's name, description, or permissions. Changes apply to all members with this role on their next request. System presets (Admin, Support, Finance, Audit) are read-only — create a custom role instead. **Permissions:** requires **manage** access to "Team & roles". **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json patch /v1/organization/roles/{roleId} openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/roles/{roleId}: patch: tags: - Team and roles summary: Update a custom role description: >- Edit a custom role's name, description, or permissions. Changes apply to all members with this role on their next request. System presets (Admin, Support, Finance, Audit) are read-only — create a custom role instead. **Permissions:** requires **manage** access to "Team & roles". **Authentication:** send your organization API key in the `X-API-Key` header. operationId: patchV1OrganizationRolesRoleid parameters: - description: Custom role ID (system presets cannot be edited) x-format: guid: true name: roleId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model887' responses: '200': description: Role updated content: '*/*': schema: $ref: '#/components/schemas/Model889' '400': description: System roles cannot be edited content: '*/*': schema: $ref: '#/components/schemas/Model890' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '404': description: Resource not found content: '*/*': schema: $ref: '#/components/schemas/Model24' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model887: type: object properties: name: type: string description: New role name minLength: 1 maxLength: 60 description: type: string description: New description maxLength: 300 permissions: $ref: '#/components/schemas/Model886' Model889: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model888' Model890: type: object properties: statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: System roles cannot be edited. Create a custom role instead. code: type: string example: ROLE_IS_SYSTEM Model47: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model24: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Resource not found code: type: string description: Machine-readable error code — switch on this, not on message text example: NOT_FOUND Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model886: type: object description: Full replacement permission map example: payouts: manage traders: view analytics: view properties: analytics: $ref: '#/components/schemas/analytics' traders: $ref: '#/components/schemas/Model882' payouts: $ref: '#/components/schemas/Model883' plans: $ref: '#/components/schemas/Model884' webhooks: $ref: '#/components/schemas/Model885' operations: $ref: '#/components/schemas/operations' billing: $ref: '#/components/schemas/billing' team: $ref: '#/components/schemas/team' settings: $ref: '#/components/schemas/settings' Model888: type: object properties: id: type: string name: type: string description: type: string permissions: $ref: '#/components/schemas/changes' isSystem: type: boolean example: false analytics: type: string description: Analytics dashboard and audit log enum: - none - view - manage Model882: type: string description: Traders, accounts, lockouts, end-of-day snapshots enum: - none - view - manage Model883: type: string description: Payout eligibility, execution, history enum: - none - view - manage Model884: type: string description: Trading plans and rules enum: - none - view - manage Model885: type: string description: Webhook endpoints and deliveries enum: - none - view - manage operations: type: string description: Time machine, revert trading day, bulk operations enum: - none - view - manage billing: type: string description: Billing cycles, events, monthly summary enum: - none - view - manage team: type: string description: Team members and roles ("manage" makes the member an admin) enum: - none - view - manage settings: type: string description: Organization profile and API keys enum: - none - view - manage changes: type: object securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Create a custom role](/platform-api/team-and-roles/create-a-custom-role.md) - [Delete an unused custom role](/platform-api/team-and-roles/delete-an-unused-custom-role.md) - [List roles (system presets + your custom roles)](/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md) - [Add a team member with a role](/platform-api/team-and-roles/add-a-team-member-with-a-role.md) - [Custom metadata](/concepts/metadata.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.