Objective-C / Zoho CRM REST APIs / Delete Related Records Using External ID
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": [
// {
// "Contact_Role": "111111000000026002",
// "External_Deal_ID": "extdeal3"
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data[0].Contact_Role" value: @"111111000000026002"];
[json UpdateString: @"data[0].External_Deal_ID" value: @"extdeal3"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"X-EXTERNAL" value: @"Contacts.External_Contact_ID"];
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"DELETE" url: @"https://domain.com/crm/v2/Contacts/extcontact3/Deals/extdeal3" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
Curl Command
curl -X DELETE
-H "Authorization: Bearer <access_token>"
-H "X-EXTERNAL: Contacts.External_Contact_ID"
-d '{
"data": [
{
"Contact_Role": "111111000000026002",
"External_Deal_ID": "extdeal3"
}
]
}'
https://domain.com/crm/v2/Contacts/extcontact3/Deals/extdeal3
Postman Collection Item JSON
{
"name": "Delete Related Records Using External ID",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "X-EXTERNAL",
"value": "Contacts.External_Contact_ID",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Contact_Role\": \"111111000000026002\",\n \"External_Deal_ID\": \"extdeal3\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/extcontact3/Deals/extdeal3",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"extcontact3",
"Deals",
"extdeal3"
]
},
"description": "In this example, extcontact3 and extdeal3 are the values of the external fields External_Contact_ID and External_Deal_ID in the Contacts and Deals modules, respectively. we will reference these values to delink the deal from the contact."
},
"response": [
]
}