Chilkat Online Tools

Perl / Zoho CRM REST APIs / Deleting a record using an external ID

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("X-EXTERNAL","Contacts.External_Contact_ID");

# resp is a HttpResponse
$resp = $http->QuickRequest("DELETE","https://domain.com/crm/v2/Contacts/extcontact3");
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_Contact_ID"
https://domain.com/crm/v2/Contacts/extcontact3

Postman Collection Item JSON

{
  "name": "Deleting a record using an 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"
      }
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/extcontact3",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "extcontact3"
      ]
    },
    "description": "In this example, we will delete the record in the Contacts module with the external value extcontact3 in the external field \"External_Contact_ID\"."
  },
  "response": [
  ]
}