/permissions

PUT /permissions

Update account permissions

Update permissions for a specific account (Super Admin only)

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

accountId query string

ID of the account to update permissions for

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

force query string

If set to 'true', applies permissions to all accounts of the specified account type

[
  "string"
]

[
  "string"
]

Try it out

Output:

Responses

Description

Permissions updated successfully

null

Description

Bad request - invalid input or missing required parameters

{
  "error": "string",
  "status": 0
}

Description

Unauthorized - not authenticated

{
  "error": "string",
  "status": 0
}

Description

Forbidden - only Super Admins can update account permissions

{
  "error": "string",
  "status": 0
}

Description

Account not found

{
  "error": "string",
  "status": 0
}

Description

Internal server error

{
  "error": "string",
  "status": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/PermissionToAccount #/components/schemas/Error

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/PermissionToAccount

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    description: Unique identifier for the permission-to-account relationship
  accountId:
    type: string
    description: ID of the account this permission is assigned to
  permissionId:
    type: integer
    description: ID of the permission that is assigned

|
export interface PermissionToAccount {
  /** Unique identifier for the permission-to-account relationship */
  id?: number;
  /** ID of the account this permission is assigned to */
  accountId?: string;
  /** ID of the permission that is assigned */
  permissionId?: number;
}

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
description: Error response object

|
export interface Error {
  /** Error message */
  error?: string;
  /** HTTP status code */
  status?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /permissions/route.ts

Or the swagger.yaml spec this documentation was generated from: /permissions/swagger.yaml