Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "allOrNone": false,
// "records": [
// {
// "attributes": {
// "type": "Account"
// },
// "Name": "Test Upsert",
// "Id": "0012o00003OBzVSAA1"
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateBool("allOrNone",.F.)
loJson.UpdateString("records[0].attributes.type","Account")
loJson.UpdateString("records[0].Name","Test Upsert")
loJson.UpdateString("records[0].Id","0012o00003OBzVSAA1")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSb("PATCH","https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",loSbRequestBody,"utf-8","application/json",loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
release loResp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJarrResp = createobject("CkJsonArray")
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = .F.
? "Response Body:"
? loJarrResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loHttp
release loJson
release loSbRequestBody
release loResp
release loSbResponseBody
release loJarrResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": "001...",
// "success": true,
// "errors": [
// ],
// "created": false
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
loJson = createobject("CkJsonObject")
i = 0
lnCount_i = loJarrResp.Size
do while i < lnCount_i
loJarrResp.ObjectAt2(i,loJson)
lcId = loJson.StringOf("id")
llSuccess = loJson.BoolOf("success")
llCreated = loJson.BoolOf("created")
j = 0
lnCount_j = loJson.SizeOfArray("errors")
do while j < lnCount_j
loJson.J = j
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loResp
release loSbResponseBody
release loJarrResp
release loJson
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"allOrNone" : false,
"records" : [{
"attributes" : {"type" : "Account"},
"Name" : "Test Upsert",
"Id" : "0012o00003OBzVSAA1"
}]
}'
https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME
Postman Collection Item JSON
{
"name": "SObject Collections Upsert",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"allOrNone\" : false,\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\"},\n \"Name\" : \"Test Upsert\",\n \"Id\" : \"0012o00003OBzVSAA1\"\n }]\n}\n\n\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME",
":FIELD_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
},
{
"key": "FIELD_NAME",
"value": "Id"
}
]
},
"description": "Use a PATCH request with sObject Collections to either create or update (upsert) up to 200 records based on an external ID field. This method returns a list of UpsertResult objects. You can choose whether to roll back the entire request when an error occurs. This request is available in API version 46 and later.\n\n[https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm)"
},
"response": [
{
"name": "Successful SObject Collections Upsert",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"allOrNone\" : false,\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\"},\n \"Name\" : \"Test Upsert\",\n \"Id\" : \"0012o00003OBzVSAA1\"\n }]\n}\n\n\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME",
":FIELD_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
},
{
"key": "FIELD_NAME",
"value": "Id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:29:54 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Sforce-Limit-Info",
"value": "api-usage=48/15000"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "[\n {\n \"id\": \"001...\",\n \"success\": true,\n \"errors\": [],\n \"created\": false\n }\n]"
}
]
}
