Delete a Contact

Endpoint

DELETE https://api.parcelengineering.com/api/v1/workspace/contacts/{id}

Removes your workspace’s custom data for the contact (your status, notes, and tags). The global Parcel contact is not affected and remains available in the Data API. The contact will no longer appear in workspace searches after deletion.

This operation is idempotent. Deleting a contact that is not in your workspace returns a success response with no error.

Delete costs 0 credits.

Caution

The Workspace API requires the Pro plan. A request from a non-Pro workspace or a non-member receives 403 forbidden.

Path parameters

Parameter	Description
id	UUID of the contact to delete from your workspace.

Example

cURL

Delete workspace contact

curl -X DELETE \
  https://api.parcelengineering.com/api/v1/workspace/contacts/3c7a9f2d-0001-4e1b-bc4a-000000000001 \
  -H "Authorization: Bearer pcl_your_api_key"

JavaScript

Delete workspace contact

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/contacts/3c7a9f2d-0001-4e1b-bc4a-000000000001',
  {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

const { data, metadata } = await response.json();

Response

Response

{
  "data": { "deleted": true },
  "metadata": { "credits": 0 }
}

Delete costs 0 credits.