Delete Account - Plugixa CRM for WordPress

Delete Account - Plugixa CRM

DELETE /plugixa-crm/v1/accounts/{id}

Move a account to the trash. It can be brought back with Restore Account or removed for good with Purge Account.

Any user with access to Plugixa CRM. With Plugixa CRM Pro roles, the user’s role must also allow deleting this account.

Moving to the trash is a delete for everything listening. The account.deleted webhook event PRO fires now, not on purge.

Request

DELETE https://your-site.example/wp-json/plugixa-crm/v1/accounts/12

Path parameters

Name	Type	Description
`id`	`integer`	The account’s id

Responses

`200` OK. The account is in the trash.

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

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

Errors

Status	Code	When
`404`	`plugixa_crm_not_found`	No account with that id, or it is already in the trash.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/accounts/12');
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 auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-crm/v1/accounts/12', {
  method: 'DELETE',
  headers: {
    'Authorization': auth,
  },
});
const { data } = await response.json();