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

      • Object Description API

      • Approval Process API

      • Custom Function API

      • Lock Unlock API

      • Related Team API

      • Currency API

      • Business Process API

      • Stage Progression API

      • product Categories API

      • Other Common API

        • Get Countries
        • Query Update Records
        • Update Group Members
        • Add Tags
        • Query Object Data
        • CRM Journal Query
        • Query All Groups
        • Query Available Tags
        • Add Group
          • Query Single Record
      • Address Book API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Add User Group

    # Description

    Add a new user group

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${cloud domain}/cgi/crm/v2/org/group/insert?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Data map
      appId String Yes Fixed value: CRM
      groupPojo Map Yes User group information
        name String Yes User group name
        status Int Yes User group status: 0-enabled, 1-disabled
        type Int Yes Type: 0-public user group
        description String Yes User group description

    # Request Example

    {
      "data": {
        "appId": "CRM",
        "groupPojo": {
          "name": "zxf",
          "description": "Test user group",
          "type": 0,
          "status": 0
        }
      }
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Unique request ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int View 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;
    Query Available Tags
    Query Single Record

    ← Query Available Tags Query Single Record→

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