v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Roles

Set default organization roles

Updates the default member role for the specified organization. Use this endpoint to configure which role is automatically assigned to new users when they join the organization. The system will validate that the specified role exists and update the organization settings accordingly. This configuration affects all new user invitations and memberships within the organization.

patch/api/v1/organizations/{org_id}/roles:set_defaults

Path parameters

org_idstring required

Unique identifier of the organization

Request body

default_member_rolestring

Unique name of the default member role

Example request

{
  "default_member_role": "member"
}

Response

Default organization roles updated successfully. Returns the updated default member role object with complete role information.

Example response

{
  "default_member": {
    "default_creator": true,
    "default_member": true,
    "dependent_roles_count": 3,
    "description": "Can create, edit, and publish content but cannot delete or manage users",
    "display_name": "Content Editor",
    "extends": "admin_role",
    "id": "role_1234abcd5678efgh",
    "is_org_role": true,
    "name": "content_editor",
    "permissions": [
      {
        "description": "Read Content",
        "name": "read:content",
        "role_name": "admin_role"
      },
      {
        "description": "Write Content",
        "name": "write:content",
        "role_name": "editor_role"
      }
    ]
  }
}