Purge CRM Connection - Plugixa Chat for WordPress

Purge CRM Connection - Plugixa Chat

DELETE /plugixa-chat/v1/crm/{id}/purge

Delete a CRM connection permanently. This cannot be undone.

Needs Plugixa Chat Pro. The signed-in user needs the plugixa_chat_delete capability. Administrators have it.

Purging does not need the trash first. It works on a live CRM connection as well as a trashed one.

Note. Purging a connection that was never trashed does not erase its stored API key. Delete it first, then purge, to be sure the key is gone.

Request

DELETE https://your-site.example/wp-json/plugixa-chat/v1/crm/6/purge

Path parameters

Name	Type	Description
`id`	`integer`	The CRM connection’s id

Responses

`200` OK. The CRM connection is gone.

{
  "success": true,
  "data": {
    "purged": true
  }
}

Field	Type	Meaning
`data.purged`	`boolean`	Always `true`

Errors

Status	Code	When
`404`	`plugixa_chat_not_found`	No CRM connection has this id.

Plus the errors every endpoint can return.

Examples

curl -s -X DELETE "https://your-site.example/wp-json/plugixa-chat/v1/crm/6/purge" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/crm/6/purge');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/crm/6/purge', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();