Description

Invalidate a custom object.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/custom/v2/data/invalid?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

This API is only applicable to custom objects (objects whose ApiName ends with __c).

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
dataObjectApiName	String	Yes	API name of the object
object_data_id	String	Yes	Data ID

Request Example

{  
  "data": {  
    "object_data_id": "hello",  
    "dataObjectApiName": ""  
  }  
}

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.

Special Notes

Differences Between V1 and V2 Custom Object Invalidation APIs:
V1 request example:

{  
  "corpAccessToken": "CORP_ACCESS_TOKEN",  
  "corpId": "CORP_ID",  
  "currentOpenUserId": "FSUID_XXXXXX",  
  "data": {  
    "dataObjectApiName": "object_Nyeoj__c",  
    "idList": ["5d27fe3642639b00017160e8", "5d27f9466e048f00013ae503"]  
  }  
}

V2 request example:

{  
  "data": {  
    "object_data_id": "5a9ce894f125ae9befxxxxxx",  
    "dataObjectApiName": "object_d4fIq__c"  
  }  
}

In V1, the keyword is idList, while in V2, it is object_data_id. Additionally, V2 does not support batch invalidation.