Fxiaoke Developer Manual Fxiaoke Developer Manual
  • APL Development Manual
  • PWC Development Manual
  • OpenAPI Documentation
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start

  • API Authorization

  • API Basics

  • OpenAPI

    • CRM Object API

    • CRM Common API

    • Address Book API

      • Personnel Role API

        • Get Users By Major Role
        • Add Role
        • Batch Add User Roles Incremental
        • Delete Role
        • Get Users By Role
        • Get Role List
        • Delete Role Members
        • Update Role Info
          • Batch Set User Roles Override
          • Get User Roles
        • Personnel API

        • User Group API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Update Role Information

    # Description

    Update role information

    # Request Specification

    Request Method: POST + application/json

    Request Path: https://${Cloud Domain}/cgi/crm/v2/special/roleUpdate?thirdTraceId=${Random String}

    Request Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Dataset
      roleName String Yes Role name
      roleCodes String Yes Role codes
      description String Yes Role description

    # Request Example

    {
      "data": {
        "roleName": "hello",
        "description": "Role description",
        "roleCodes": "00000000000000000000000000000006"
      }
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Unique request ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int Error Codes

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # Notes

    • Do not use the message field in the response for logical judgment, as errorMessage may change;
    Delete Role Members
    Batch Set User Roles Override

    ← Delete Role Members Batch Set User Roles Override →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式