Chilkat Online Tools

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

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-EXTERNAL","Contacts.External_Contact_ID")

loo_Resp = loo_Http.QuickRequest("DELETE","https://domain.com/crm/v2/Contacts/extcontact3")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http

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": [
  ]
}