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

    Create Preset Object

    # Not recommended to continue using offline API!!!

    # Description

    Create a preset object

    # Request Specification

    Method: POST + application/json

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

    # Request Parameters

    Parameter Type Required Description
    corpAccessToken String Yes corpAccessToken (returned by Get Token API (opens new window))
    corpId String Yes corpId (returned by Get Token API (opens new window))
    currentOpenUserId String Yes currentOpenUserId (returned by 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.
    hasSpecifyTime Boolean No Whether creation time can be specified (defaults to false when not provided, meaning the create_time field in parameters will be ignored)
    hasSpecifyCreatedBy Boolean No Creator (defaults to false when not provided, meaning the created_by field in parameters will be ignored)
    includeDetailIds Boolean No Whether to include detail objects (when creating master-detail objects together, whether to return detail object ID list. true returns, false doesn't, default is false)
    data Map Yes Data Map
      igonreMediaIdConvert Boolean No File path type: true when file path is npath (starting with N_); otherwise false. Defaults to true when not provided
      object_data Map Yes Object data
        dataObjectApiName String Yes Object apiName
        campaign_members_status String Yes Participation status
        name String Yes Member ID
        object_describe_api_name String Yes object_describe_api_name
        owner List[String] Yes Owner
        record_type String Yes Business type
        campaign_members_type String Yes Type
        marketing_event_id String Yes Marketing event name
      details Map No Detail object data (key is apiName, value is data Map)
        detail_api_name Map Yes Detail object data
      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 search

    # Request Example

    {
      "hasSpecifyTime": true,
      "includeDetailIds": true,
      "corpAccessToken": "{corpAccessToken}",
      "triggerWorkFlow": true,
      "currentOpenUserId": "{currentOpenUserId}",
      "corpId": "{corpId}",
      "data": {
        "object_data": {
          "campaign_members_status": "18",
          "owner": [
            "FSUID_xx1"
          ],
          "campaign_members_type": "18",
          "marketing_event_id": "603dabc14ae65400011aec90",
          "object_describe_api_name": "hello",
          "name": "",
          "dataObjectApiName": "CampaignMembersObj",
          "record_type": "603dabc14ae65400011aec90"
        },
        "optionInfo": {
          "skipFuncValidate": true,
          "isDuplicateSearch": true,
          "useValidationRule": true
        },
        "details": {
          "detail_api_name": {}
        },
        "igonreMediaIdConvert": false
      },
      "hasSpecifyCreatedBy": true,
      "triggerApprovalFlow": true
    }
    

    # 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 return value for logical judgment, as errorMessage may change;
    Query Employee By Mobile
    Delete Preset Object

    ← Query Employee By Mobile Delete Preset Object →

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