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

    • Other API

      • Task Todo API

      • Attendance Field Work API

      • Collaborative Approval API

      • Enterprise Connect API

      • Message API

      • Material Management API

      • Network Disk API

      • Marketing API

      • File Service

      • ERP API

      • BI API

      • Offline API

        • Set Member Status Batch
        • Update Department
        • Query Updated Employee List By Time Range
        • Set Member Status
        • Get Department Details
        • Query Employee Info By OpenUserId
        • Set Department Status
        • Update Member
        • Get Department List
        • Query Employee By Mobile
        • Create Preset Object
        • Delete Preset Object
        • Query Preset Object Details
        • Invalidate Preset Object
        • Query Preset Object List
        • Update Preset Object
          • Recover Preset Object
          • Change Preset Object Owner
          • Create Erp Object
          • Query Erp Object List
          • Query Erp Object Details
          • Update Erp Object
          • Recover Erp Object
          • Invalidate Erp Object
          • Change Erp Object Owner
          • Delete Erp Object
    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Update Preset Object

    # Not recommended to continue using offline APIs!!!

    # Description

    Update preset object

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Cloud Domain}/cgi/crm/v2/data/update?thirdTraceId=${Random String}

    # Request Parameters

    Parameter Type Required Description
    corpAccessToken String Yes corpAccessToken (returned via Get Token API (opens new window))
    corpId String Yes corpId (returned via Get Token API (opens new window))
    currentOpenUserId String Yes currentOpenUserId (returned via Query Employee by Phone API (opens new window))
    triggerApprovalFlow Boolean No Whether to trigger approval flow (defaults to true when not provided, indicating triggering). This parameter applies to all objects.
    triggerWorkFlow Boolean No Whether to trigger workflow (defaults to true when not provided, indicating triggering). This parameter applies to all objects.
    data Map Yes Data Map
      object_data Map Yes Object data (corresponding to fields in CRM backend object description)
        dataObjectApiName String Yes Object API name, fixed value: CampaignMembersObj
        _id String Yes ID of the data to be updated
      details Map No Sub-object data (key as apiName, value as data Map)
      igonreMediaIdConvert Boolean No File path type: true for npath (starting with N_), false otherwise. Defaults to true when not provided.
      optionInfo Map No Validation options
        skipFuncValidate Boolean No Skip function pre-validation
        useValidationRule Boolean No Whether to trigger validation rules
        isDuplicateSearch Boolean No Whether to trigger duplicate check

    # Request Example

    {
      "corpAccessToken": "{corpAccessToken}",
      "triggerWorkFlow": true,
      "currentOpenUserId": "{currentOpenUserId}",
      "corpId": "{corpId}",
      "data": {
        "object_data": {
          "_id": "hello",
          "dataObjectApiName": "CampaignMembersObj"
        },
        "optionInfo": {
          "skipFuncValidate": true,
          "isDuplicateSearch": true,
          "useValidationRule": true
        },
        "details": {
          "api_name": [
            {
              "_id": "88888888",
              "name": "modify"
            }
          ]
        },
        "igonreMediaIdConvert": false
      },
      "triggerApprovalFlow": true
    }
    

    # 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 judgments, as errorMessage may change;
    Query Preset Object List
    Recover Preset Object

    ← Query Preset Object List Recover Preset Object →

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